1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DescribeVpcPrivateIpAddresses) is used to query VPC private IP information.
Only used IPs can be queried. When an unused IP is queried, this API does not report an error, but it does not appear in the return result.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-01-10 18:58:39.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeVpcPrivateIpAddresses |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| VpcId | Yes | No | String | VPC instance ID, e.g., vpc-f49l6u0z. Example: vpc-rkxd3pgh |
| PrivateIpAddresses | Yes | No | Array of String | Private IP address list. Batch query supports up to 10 items in a single request.Example: ["10.4.2.2\n","10.4.2.3\n","10.4.2.17\n"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| VpcPrivateIpAddressSet | Array of VpcPrivateIpAddress | List of private IP address information. Example:View |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | The parameter value is invalid. |
| ResourceNotFound | The resource does not exist |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |