DescribeUsedIpAddress

最后更新时间：2024-11-25 20:07:14

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to query the IP usage of a subnet or VPC.
If the IP is occupied, the resource type and ID associated with the are is returned. If the IP is not used, it returns null.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeUsedIpAddress.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
VpcId	Yes	String	VPC instance ID.
SubnetId	No	String	Subnet instance ID
IpAddresses.N	No	Array of String	List of IPs to be queried. The IPs must be within the VPC or subnet. Up to 100 IPs can be queried at a time.
Offset	No	Integer	The offset. Default value: 0
Limit	No	Integer	The number of returned results. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name	Type	Description
IpAddressStates	Array of IpAddressStates	Information of resources bound with the queried IPs Note: This parameter may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Number of taken IPs Note: This parameter may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the IP usage of a subnet

This example shows you how to query usage of IPs of a subnet.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsedIpAddress
<Common request parameters>

{
    "VpcId": "vpc-bx0vq623",
    "SubnetId": "subnet-dl3wd0vq",
    "IpAddresses": [
        "10.0.0.1",
        "10.0.0.2"
    ]
}

Output Example

{
    "Response": {
        "IpAddressStates": [
            {
                "VpcId": "vpc-bx0vq623",
                "SubnetId": "subnet-dl3wd0vq",
                "IpAddress": "10.0.0.1",
                "ResourceType": "ENI",
                "ResourceId": "eni-bjekqff1"
            },
            {
                "VpcId": "vpc-bx0vq623",
                "SubnetId": "subnet-dl3wd0vq",
                "IpAddress": "10.0.0.2",
                "ResourceType": "ENI",
                "ResourceId": "eni-bjekqff2"
            }
        ],
        "TotalCount": 2,
        "RequestId": "2aaa54f5-2809-4b95-b3a5-13ce72d05759"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.ParameterMismatch	Invalid parameter format

tencent cloud

Recent Pages