1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (DescribeVpcInstances) is used to query the list of CVM instances under a VPC.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-04-10 01:37:19.
The interface is both signature verification and authentication.
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: DescribeVpcInstances |
| 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 |
| Filters | Yes | No | Array of Filter | Filter criteria. Parameters RouteTableIds and Filters must not be specified simultaneously. Example:View |
| Offset | No | No | Uint64 | Offset. Example: 0 |
| Limit | No | No | Uint64 | Number of request objects. Example: 20 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| InstanceSet | Array of CvmInstance | CVM instance list. Example:View |
| TotalCount | Uint64 | Number of CVM instances that meet the criteria. Example: 1 |
| 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.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| InvalidParameterValue.Range | The parameter value is not within the specified range. |