SetCcnRegionBandwidthLimits

Last updated: 2023-08-23 14:11:35

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API (SetCcnRegionBandwidthLimits) is used to set the outbound bandwidth cap for CCNs in each region. This API can only set the outbound bandwidth cap for regions in the network instances that have already been associated.

A maximum of 100 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: SetCcnRegionBandwidthLimits.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	No	String	Common Params. This parameter is not required for this API.
CcnId	Yes	String	The CCN instance ID, such as `ccn-f49l6u0z`.
CcnRegionBandwidthLimits.N	Yes	Array of CcnRegionBandwidthLimit	The outbound bandwidth cap of each CCN region.
SetDefaultLimitFlag	No	Boolean	Whether to restore the region outbound bandwidth limit or inter-region bandwidth limit to default 1 Gbps. Valid values: `false` (no); `true` (yes). Default value: `false`. When the parameter is set to `true`, the CCN instance created will not be displayed in the console.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Setting the outbound bandwidth limit for CCN regions

This example shows you how to set the outbound bandwidth limit for CCN regions. In this case, we will set the limit for ap-guangzhou to 1,000 Mbps and ap-shanghai to 500 Mbps.

Input Example

https://vpc.tencentcloudapi.com/?Action=SetCcnRegionBandwidthLimits
&CcnId=ccn-gree226l
&CcnRegionBandwidthLimits.0.Region=ap-guangzhou
&CcnRegionBandwidthLimits.0.BandwidthLimit=1000
&CcnRegionBandwidthLimits.1.Region=ap-shanghai
&CcnRegionBandwidthLimits.1.BandwidthLimit=500
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "9c53ff69-1bb6-4c89-adbb-812233a85acc"
    }
}

Example2 Setting the inter-region bandwidth limit for CCN regions

To set the inter-region bandwidth limit, you need to specify the source and destination regions. If the source or destination region is a BM region, please set the IsBm or DstIsBm parameter to be true. In the example, the inter-region bandwidth limit between ap-guangzhou and ap-shanghai BM regions is 1,000 Mbps, and that between ap-guangzhou and ap-beijing regions is 500 Mbps.

Input Example

https://vpc.tencentcloudapi.com/?Action=SetCcnRegionBandwidthLimits
&CcnId=ccn-gree226l
&CcnRegionBandwidthLimits.0.Region=ap-guangzhou
&CcnRegionBandwidthLimits.0.BandwidthLimit=1000
&CcnRegionBandwidthLimits.0.DstRegion=ap-shanghai
&CcnRegionBandwidthLimits.0.DstIsBm=true
&CcnRegionBandwidthLimits.1.Region=ap-guangzhou
&CcnRegionBandwidthLimits.1.BandwidthLimit=500
&CcnRegionBandwidthLimits.1.DstRegion=ap-beijing
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "9c53ff69-1bb6-4c89-adbb-812233a85acc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

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
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.NotPostpaidCcnOperation	Unsupported operation: the current CCN instance is not billed on a pay-as-you-go basis.

tencent cloud

Recent Pages