All Products
Search

This Product

    Cloud Enterprise Network:SetCenInterRegionBandwidthLimit

    Document Center

    Cloud Enterprise Network:SetCenInterRegionBandwidthLimit

    Last Updated:Oct 22, 2024

    Configures, modifies, or deletes the bandwidth of inter-region connections for a Basic Edition transit router.

    Operation description

    This operation is used to manage bandwidth of inter-region connections only for Basic Edition transit routers.

    Prerequisites

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

    You can call the SetCenInterRegionBandwidthLimit operation to configure, change, or remove the bandwidth limit of an inter-region connection.

    • If you set BandwidthLimit to a value other than 0, the bandwidth of the inter-region connection is set to the specified value.
    • If you set BandwidthLimit to 0, the bandwidth of the inter-region connection is no longer limited.

    Limits

    • The bandwidth limit of an inter-region connection cannot exceed the bandwidth limit of the associated bandwidth plan.

    • The sum of bandwidth limits of all inter-region connections cannot exceed the bandwidth limit of the associated bandwidth plan.

    • If bandwidth multiplexing is enabled for an inter-region connection, you cannot change the bandwidth of the inter-region connection.

    • The SetCenInterRegionBandwidthLimit operation can be used to configure, modify, or delete the bandwidth of inter-region connections only for Basic Edition transit routers.

      To configure, modify, or delete the bandwidth of inter-region connections for Enterprise Edition transit routers, call the CreateTransitRouterPeerAttachment , UpdateTransitRouterPeerAttachmentAttribute , or DeleteTransitRouterPeerAttachment operation.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:SetCenInterRegionBandwidthLimitupdate
    • CenInstance
      acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    CenIdstringYes

    The ID of the CEN instance.

    		cen-7qthudw0ll6jmx****
    LocalRegionIdstringYes

    The ID of the local region.

    You can call the DescribeChildInstanceRegions operation to query regions where you can attach network instances to a CEN instance.

    		cn-hangzhou
    OppositeRegionIdstringYes

    The ID of the peer region.

    		us-west-1
    BandwidthLimitlongYes

    The maximum bandwidth value of the inter-region connection. Unit: Mbit/s.

    		8
    BandwidthTypestringNo

    The bandwidth allocation method. Valid values:

    BandwidthPackage: allocates bandwidth from a bandwidth plan.

    		BandwidthPackage

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		530BC816-F575-412A-AAB2-435125D26328

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400MissingParam.CbnBandwidthPackageIdThere are more than one suitable cen bandwidth packageThe error message returned because the CbnBandwidthPackageId parameter is not set.
    400AttrMismatching.CbnBandwidthPackageId%s-
    400OperationFailed.InvalidOperationThe operation is failed because the operation is not support.-
    400OperationUnsupported.AttachmentThe 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.
    400InvalidOperation.UnsupportChargeTypeThe charge type is not supported by this operation.The error message returned because the specified billing method does not support this operation.
    400OperationUnsupported.TrafficQosPolicyExistOperation unsupported because traffic qos policy exists.The error message returned because the specified QoS policy already exists.
    400OperationUnsupported.BandwidthTypeThe specified BandwidthType does not support the operation.The error message returned because this operation is not supported by the specified bandwidth type.
    400IllegalParam.BandwidthTypeBandwidthType is illegal.The error message returned because the specified bandwidth plan type is invalid.
    400IllegalParam.BandwidthBandwidth is illegal.The error message returned because the specified bandwidth plan ID is invalid.
    400ParamExclusive.BandwidthTypeAndCenBandwidthPackageIdDataTransfer and CenBandwidthPackageId is mutually exclusive.When the value of bandwidthType is DataTransfer, the CenBandwidthPackageId field cannot be set.
    400IdentityRegistrationStatusNotSupportReal name registration of enterprises required.Real name registration of enterprises required.
    400IllegalParam.BandwidthLessThanQosPolicyBandwidthThe 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.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-08-16The Error code has changedView Change Details
    2024-05-17The Error code has changed. The request parameters of the API has changedView Change Details
    2023-09-08The Error code has changedView Change Details