Domain name for API request: vpc.tencentcloudapi.com.
This API (DescribeVpcs) is used to query the VPC list.
A maximum of 100 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
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: DescribeVpcs. |
| 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. |
| VpcIds.N | No | Array of String | The VPC instance ID, such as vpc-f49l6u0z. Each request supports a maximum of 100 instances. VpcIds and Filters cannot be specified at the same time. |
| Filters.N | No | Array of Filter | Filter condition. VpcIds and Filters cannot be specified at the same time.vpc-f49l6u0z. |
| Offset | No | String | Offset. Default value: 0. |
| Limit | No | String | Number of returned results. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The number of objects meeting the condition. |
| VpcSet | Array of Vpc | The VPC object. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://vpc.tencentcloudapi.com/?Action=DescribeVpcs
&Offset=0
&Limit=2
&Filters.0.Name=is-default
&Filters.0.Values.0=false
&Filters.1.Name=cidr-block
&Filters.1.Values.0=10.8.0.0
&Filters.1.Values.1=192.168.0.0
&<Common request parameter>{
"Response": {
"VpcSet": [
{
"VpcId": "vpc-p5sf61yj",
"VpcName": "Test dhcp",
"CidrBlock": "10.0.0.0/16",
"Ipv6CidrBlock": "3402:4e00:20:1200::/56",
"IsDefault": false,
"EnableMulticast": false,
"CreatedTime": "2018-04-25 10:26:26",
"DhcpOptionsId": "dopt-8g7k5qfq",
"DnsServerSet": [
"10.0.0.1",
"183.60.82.98"
],
"DomainName": "aa.bb.cc"
}
],
"TotalCount": 1,
"RequestId": "6a44afb7-0644-4ff9-9761-3502f99d3a15"
}
}This example shows you how to query VPCs bound to a tag-key pair (city: Shanghai).
https://vpc.tencentcloudapi.com/?Action=DescribeVpcs
&Offset=0
&Limit=2
&Filters.0.Name=tag:city
&Filters.0.Values.0=shanghai
&<Common request parameter>{
"Response": {
"VpcSet": [
{
"VpcId": "vpc-p5sf61yj",
"VpcName": "Test dhcp",
"CidrBlock": "10.0.0.0/16",
"Ipv6CidrBlock": "3402:4e00:20:1200::/56",
"IsDefault": false,
"EnableMulticast": false,
"CreatedTime": "2018-04-25 10:26:26",
"DhcpOptionsId": "dopt-8g7k5qfq",
"DnsServerSet": [
"10.0.0.1",
"183.60.82.98"
],
"TagSet": [
{
"Key": "city",
"Value": "shanghai"
}
],
"AssistantCidrSet": [
{
"CidrBlock": "192.168.1.0/24",
"AssistantType": 0,
"SubnetSet": []
}
],
"DomainName": "aa.bb.cc"
}
],
"TotalCount": 1,
"RequestId": "6a44afb7-0644-4ff9-9761-3502f99d3a15"
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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 |
|---|---|
| InvalidParameter.Coexist | The parameters cannot be specified at the same time. |
| 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?