SetCenInterRegionBandwidthLimit - Cloud Enterprise Network

You can call the SetCenInterRegionBandwidthLimit operation to set, modify, or delete the inter-region bandwidth between two regions in a bandwidth plan for a Basic Edition transit router.

Operation description

The target Cloud Enterprise Network (CEN) instance must be associated with a bandwidth plan. For more information, see CreateCenBandwidthPackage and AssociateCenBandwidthPackage.

Limits

The target Cloud Enterprise Network (CEN) instance already has a bandwidth plan. For more information, see CreateCenBandwidthPackage and AssociateCenBandwidthPackage.

You can call the SetCenInterRegionBandwidthLimit API to set, modify, or delete the bandwidth for inter-region communication:

The SetCenInterRegionBandwidthLimit operation supports setting, modifying, or deleting the inter-region communication bandwidth for Basic Edition transit routers only.
You cannot modify the inter-region communication bandwidth if bandwidth multiplexing is enabled for the inter-region connection.

Limits

The maximum bandwidth for an inter-region communication cannot exceed the peak bandwidth of the bandwidth plan.
The total bandwidth of all inter-region communications in a bandwidth plan cannot exceed the peak bandwidth of the plan.
You cannot modify the inter-region communication bandwidth if bandwidth multiplexing is enabled for the inter-region connection.
You can use the SetCenInterRegionBandwidthLimit API operation to set, modify, or delete the inter-region communication bandwidth for Basic Edition transit routers only.

To set, modify, or delete the inter-region communication bandwidth for an Enterprise Edition transit router, use the CreateTransitRouterPeerAttachment, UpdateTransitRouterPeerAttachmentAttribute, and DeleteTransitRouterPeerAttachment API operations.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:SetCenInterRegionBandwidthLimit

update

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	Yes	The ID of the CEN instance.	cen-7qthudw0ll6jmx****
LocalRegionId	string	Yes	The ID of the local region. Call the DescribeChildInstanceRegions operation to query the regions where network instances can be attached to a CEN instance.	cn-hangzhou
OppositeRegionId	string	Yes	The ID of the peer region.	us-west-1
BandwidthLimit	integer	Yes	The inter-region bandwidth between the two regions. Unit: Mbps.	8
BandwidthType	string	No	The method used to allocate bandwidth. Valid value: BandwidthPackage (default): allocates bandwidth from a bandwidth plan.	BandwidthPackage

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	530BC816-F575-412A-AAB2-435125D26328

Examples

Success response

JSON format

{
  "RequestId": "530BC816-F575-412A-AAB2-435125D26328"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.CbnBandwidthPackageId	There are more than one suitable cen bandwidth package	The error message returned because the CbnBandwidthPackageId parameter is not set.
400	AttrMismatching.CbnBandwidthPackageId	%s
400	OperationFailed.InvalidOperation	The operation is failed because the operation is not support.
400	OperationUnsupported.Attachment	The cross region connection contains an existing bandwidth. The operation is not supported.	The error message returned because bandwidth multiplexing is enabled for the inter-region connection.
400	InvalidOperation.UnsupportChargeType	The charge type is not supported by this operation.	The error message returned because the specified billing method does not support this operation.
400	OperationUnsupported.TrafficQosPolicyExist	Operation unsupported because traffic qos policy exists.	The error message returned because the specified QoS policy already exists.
400	OperationUnsupported.BandwidthType	The specified BandwidthType does not support the operation.	The error message returned because this operation is not supported by the specified bandwidth type.
400	IllegalParam.BandwidthType	BandwidthType is illegal.	The error message returned because the specified bandwidth plan type is invalid.
400	IllegalParam.Bandwidth	Bandwidth is illegal.	The error message returned because the specified bandwidth plan ID is invalid.
400	ParamExclusive.BandwidthTypeAndCenBandwidthPackageId	DataTransfer and CenBandwidthPackageId is mutually exclusive.	When the value of bandwidthType is DataTransfer, the CenBandwidthPackageId field cannot be set.
400	IdentityRegistrationStatusNotSupport	Real name registration of enterprises required.	Real name registration of enterprises required.
400	IllegalParam.BandwidthLessThanQosPolicyBandwidth	The input bandwidth value is less than the sum of the Qos policy bandwidth.	The input bandwidth value is less than the sum of the Qos policy bandwidth.
400	OperationUnsupported.RegionId	The specified RegionId does not support the operation.	The error message returned because this operation is not supported in the specified region.
400	QuotaExceeded.Bandwidth	Bandwidth quota exceeded.	Bandwidth quota exceeded.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
400	IncorrectStatus.TransitRouter	The resource is not in a valid state for the operation.	The CEN TR instance is not in a valid state for the operation. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.