Domain name for API request: vpc.tencentcloudapi.com.
This API (DescribeCcns) is used to query the CCN 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: DescribeCcns. |
| 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. |
| CcnIds.N | No | Array of String | The CCN instance ID, such as ccn-f49l6u0z. Each request can have a maximum of 100 instances. CcnIds and Filters cannot be specified at the same time |
| Filters.N | No | Array of Filter | Filter conditions. CcnIds and Filters cannot be specified at the same time.vpc-f49l6u0z.tag:tag-key - String - Required: no - (Filter condition) Filters by tag key pair. For this parameter, tag-key will be replaced with a specific tag key. For more information, see this example: Querying the list of CCNs bound to tags. |
| Offset | No | Integer | Offset |
| Limit | No | Integer | The returned quantity |
| OrderField | No | String | Order fields support CcnId, CcnName, CreateTime, State, and QosLevel |
| OrderDirection | No | String | Order methods. Ascending: ASC, Descending: DESC. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The number of objects meeting the condition. |
| CcnSet | Array of CCN | CCN 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=DescribeCcns
&<Common request parameters>
&CcnIds.0=ccn-8j0phqix
&CcnIds.1=ccn-gree226l
{
"Response": {
"CcnSet": [
{
"CcnId": "ccn-8j0phqix",
"CcnName": "test",
"CcnDescription": "",
"InstanceCount": 0,
"CreateTime": "2018-06-10 16:21:35",
"State": "AVAILABLE"
},
{
"CcnId": "ccn-gree226l",
"CcnName": "test",
"CcnDescription": "",
"InstanceCount": 1,
"CreateTime": "2018-06-10 22:04:56",
"State": "ISOLATED"
}
],
"TotalCount": 2,
"RequestId": "73159790-39b3-48e8-9d61-29e11eed1acd"
}
}
https://vpc.tencentcloudapi.com/?Action=DescribeCcns
&<Common request parameters>
&Filters.0.Name=ccn-name
&Filters.0.Values.0=test
{
"Response": {
"CcnSet": [
{
"CcnId": "ccn-8j0phqix",
"CcnName": "test",
"CcnDescription": "",
"InstanceCount": 0,
"CreateTime": "2018-06-10 16:21:35",
"State": "AVAILABLE"
},
{
"CcnId": "ccn-gree226l",
"CcnName": "test",
"CcnDescription": "",
"InstanceCount": 1,
"CreateTime": "2018-06-10 22:04:56",
"State": "ISOLATED"
},
{
"CcnId": "ccn-nzwnkrgt",
"CcnName": "test name",
"CcnDescription": "test description",
"InstanceCount": 0,
"CreateTime": "2018-06-18 11:18:30",
"State": "AVAILABLE"
},
{
"CcnId": "ccn-nrych3fn",
"CcnName": "test name",
"CcnDescription": "test description",
"InstanceCount": 0,
"CreateTime": "2018-06-18 11:20:58",
"State": "AVAILABLE"
}
],
"TotalCount": 4,
"RequestId": "d1f17eef-c7c9-4abe-b9ea-843fa5c8db16"
}
}
This example shows you how to query the CCN instances associated with the tag env:test.
https://vpc.tencentcloudapi.com/?Action=DescribeCcns
&<Common request parameters>
&Filters.0.Name=tag:env
&Filters.0.Values.0=test
{
"Response": {
"CcnSet": [
{
"CcnId": "ccn-nzwnkrgt",
"CcnName": "test name",
"CcnDescription": "test description",
"InstanceCount": 0,
"CreateTime": "2018-06-18 11:18:30",
"State": "AVAILABLE",
"TagSet": [
{
"Key": "env",
"Value": "test"
},
{
"Key": "TAG_TEST",
"Value": "1111"
}
]
},
{
"CcnId": "ccn-nrych3fn",
"CcnName": "test name",
"CcnDescription": "test description",
"InstanceCount": 0,
"CreateTime": "2018-06-18 11:20:58",
"State": "AVAILABLE",
"TagSet": [
{
"Key": "TAG_TEST1",
"Value": "tag1"
},
{
"Key": "env",
"Value": "test"
}
]
}
],
"TotalCount": 2,
"RequestId": "d1f17eef-c7c9-4abe-b9ea-843fa5c8db16"
}
}
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 | A parameter error occurred. |
| 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. |
| InvalidParameterValue.TooLong | Invalid parameter value. The parameter value is too long. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?