DescribeVpcPrivateIpAddresses

Last updated: 2020-07-31 14:30:25

1. API Description

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

This API (DescribeVpcPrivateIpAddresses) is used to query the private IP information of a VPC.

This API is used to query only the information of IP addresses that are already in use. When querying IPs that have not yet been used, this API will not report an error, but the IPs will not appear in the returned results.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeVpcPrivateIpAddresses.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
VpcId Yes String The ID of the VPC, such as vpc-f49l6u0z.
PrivateIpAddresses.N Yes Array of String The private IP address list. Each request supports a maximum of 10 batch querying.

3. Output Parameters

Parameter Name Type Description
VpcPrivateIpAddressSet Array of VpcPrivateIpAddress The list of private IP address information.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the private IPs of the VPC in batches

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeVpcPrivateIpAddresses
&VpcId=vpc-rkxd3pgh
&PrivateIpAddresses.0=10.4.2.2
&PrivateIpAddresses.1=10.4.2.3
&PrivateIpAddresses.2=10.4.2.17
&<common request parameters>

Output Example

{
  "Response": {
    "VpcPrivateIpAddressSet": [
      {
        "PrivateIpAddress": "10.4.2.2",
        "PrivateIpAddressType": "CTSDB",
        "CidrBlock": "10.4.2.0/24",
        "CreatedTime": "2018-12-27 15:40:10"
      },
      {
        "PrivateIpAddress": "10.4.2.3",
        "PrivateIpAddressType": "CFS",
        "CidrBlock": "10.4.2.0/24",
        "CreatedTime": "2018-09-02 16:48:59"
      },
      {
        "PrivateIpAddress": "10.4.2.17",
        "PrivateIpAddressType": "CVM",
        "CidrBlock": "10.4.2.0/24",
        "CreatedTime": "2018-09-02 16:48:59"
      }
    ],
    "RequestId": "75221557-b667-440a-8cfe-ccd1bde2a234"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

Command Line Interface

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 Invalid parameter value
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
ResourceNotFound The resource does not exist.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help