Virtual Private Cloud
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Quick Start
- VPC Connections
- Operation Guide
- Virtual Private Cloud (VPC)
- Classiclink
- Subnets
- Route Tables
- IPs and ENIs
- Network Connection
- Security Management
- Security Groups
- Managing Security Groups
- Managing Security Group Rules
- Network ACL
- Parameter Template
- Diagnostic Tools
- Traffic Mirroring
- Practical Tutorial
- Migrating from the Classic Network to VPC
- Best Practices of Security Group Change
- Troubleshooting
- API Documentation
- Making API Requests
- VPC APIs
- Route Table APIs
- Elastic Public IP APIs
- Elastic IPv6 APIs
- Highly Available Virtual IP APIs
- ENI APIs
- Bandwidth Package APIs
- NAT Gateway APIs
- Direct Connect Gateway APIs
- Cloud Connect Network APIs
- Network ACL APIs
- Network Detection-Related APIs
- Flow Log APIs
- Gateway Traffic Monitor APIs
- Private Link APIs
- Other APIs
- Subnet APIs
- VPN Gateway APIs
- Security Group APIs
- Network Parameter Template-Related APIs
- Snapshot Policy APIs
- FAQs
DescribeVpcInstances
Last updated: 2024-11-25 20:07:13
1. API Description
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.
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: 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. |
3. Output Parameters
| 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. |
4. Example
Example1 Querying the list of VPC-based CVM instances
Input Example
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>
Output Example
{
"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"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| 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. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No