Domain name for API request: vpc.intl.tencentcloudapi.com.
This API (DescribeVpcInstances) is used to query a list of VCM instances on VPC.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeVpcInstances. |
| 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. |
| Filters.N | Yes | Array of Filter | Filter condition. RouteTableIds and Filters cannot be specified at the same time.vpc-f49l6u0z. |
| Offset | No | Integer | Offset. |
| Limit | No | Integer | The number of requested objects. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceSet | Array of CvmInstance | List of CVM instances. |
| TotalCount | Integer | The number of eligible CVM instances. |
| 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. |
https://vpc.intl.tencentcloudapi.com/?Action=DescribeVpcInstances
&Filters.0.Name=vpc-id
&Filters.0.Values.0=vpc-12345678
&Offset=0
&Limit=10
&<Common request parameters>{
"Response": {
"InstanceSet": [
{
"VpcId": "vpc-12345678",
"SubnetId": "subnet-12345678",
"InstanceId": "ins-12345678",
"InstanceName": "test",
"InstanceState": "RUNNING",
"InstanceType": "S2.SMALL2",
"CPU": 1,
"Memory": 1,
"EniLimit": 2,
"EniIpLimit": 2,
"InstanceEniCount": 1,
"CreatedTime": "2020-01-01 10:00:00"
}
],
"TotalCount": 1,
"RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.ModuleError | Internal module error |
| InvalidParameter.FilterInvalidKey | The specified filter condition does not exist. |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.Range | The parameter value is not in the specified range. |
| ResourceNotFound | The resource does not exist. |
文档反馈