Domain name for API request: vpc.tencentcloudapi.com.
This API is used to query the bandwidth limits of a CCN instance. Monthly-subscribed CCNs only support Inter-region Bandwidth Limits, while the pay-as-you-go CCNs support both the Inter-region Bandwidth Limits and Region Outbound Bandwidth Limits.
A maximum of 20 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: GetCcnRegionBandwidthLimits. |
| 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. |
| CcnId | Yes | String | The CCN instance ID, such as ccn-f49l6u0z. |
| Filters.N | No | Array of Filter | The filter condition. |
| SortedBy | No | String | The sorting condition. Valid values: BandwidthLimit and ExpireTime. |
| Offset | No | Integer | The offset. |
| Limit | No | Integer | The returned quantity. |
| OrderBy | No | String | In ascending or descending order. Valid values: 'ASC' and 'DESC'. |
| Parameter Name | Type | Description |
|---|---|---|
| CcnBandwidthSet | Array of CcnBandwidthInfo | The outbound bandwidth limits of regions in a CCN instance. Note: this field may return null, indicating that no valid value was found. |
| TotalCount | Integer | The number of eligible objects. Note: this field may return null, indicating that no valid value was found. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the outbound bandwidth limits of a pay-as-you-go CCN, for which the ExpireTime and RenewFlag parameters can be ignored.
https://vpc.tencentcloudapi.com/?Action=GetCcnRegionBandwidthLimits
&<Common request parameters>
&CcnId=ccn-1pdchck1{
"Response": {
"CcnBandwidthSet": [
{
"CcnRegionBandwidthLimit": {
"Region": "ap-guangzhou",
"IsBm": false,
"BandwidthLimit": 10
},
"CcnId": "ccn-1pdchck1",
"RegionFlowControlId": "fcr-krx0mfoi",
"CreateTime": "2020-05-20 16:29:44",
"ExpireTime": "2020-05-20 16:29:44",
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
}
],
"TotalCount": 1,
"RequestId": "639c4bff-ff57-4734-bd72-f543df3b0771"
}
}This example shows you how to query the cross-region outbound bandwidths for monthly-subscribed CCN and obtain two instances with a cross-region bandwidth limit. The fcr-crrnp6w4 instance has NOTIFY_AND_MANUAL_RENEW (no auto-renewal) for the RenewFlag parameter, and the fcr-lnfsgh4y instance has NOTIFY_AND_AUTO_RENEW (auto-renewal) for the RenewFlag parameter.
https://vpc.tencentcloudapi.com/?Action=GetCcnRegionBandwidthLimits
&<Common request parameters>
&CcnId=ccn-2gxeenq2{
"Response": {
"CcnBandwidthSet": [
{
"CcnRegionBandwidthLimit": {
"Region": "ap-guangzhou",
"IsBm": false,
"BandwidthLimit": 1,
"DstRegion": "ap-shanghai",
"DstIsBm": false
},
"CcnId": "ccn-2gxeenq2",
"RegionFlowControlId": "fcr-crrnp6w4",
"CreateTime": "2020-06-10 14:48:13",
"ExpireTime": "2020-07-10 15:47:05",
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW"
},
{
"CcnRegionBandwidthLimit": {
"Region": "ap-nanjing",
"IsBm": false,
"BandwidthLimit": 1,
"DstRegion": "ap-chengdu",
"DstIsBm": false
},
"CcnId": "ccn-2gxeenq2",
"RegionFlowControlId": "fcr-lnfsgh4y",
"CreateTime": "2020-06-10 15:55:29",
"ExpireTime": "2020-07-10 15:55:29",
"RenewFlag": "NOTIFY_AND_AUTO_RENEW"
}
],
"TotalCount": 2,
"RequestId": "39db643d-64ba-456b-91c6-279115682ad2"
}
}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 | A parameter error occurred. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?