All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenInterRegionBandwidthLimits

Last Updated:Oct 22, 2024

Queries the bandwidth of connections between regions.

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:DescribeCenInterRegionBandwidthLimitsget
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/*
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.

10
CenIdstringNo

The ID of the Cloud Enterprise Network (CEN) instance.

cen-pfa6ugf3xl0qsd****
TrRegionIdstringNo

The region ID of the transit router.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

ccn-cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

7A30C665-8766-5AAA-9274-C97380E2D850
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

1
CenInterRegionBandwidthLimitsarray<object>

A list of inter-region connections.

CenInterRegionBandwidthLimitobject
Statusstring

The bandwidth status of the inter-region connection. Valid values:

  • Active
  • Modifying
Active
BandwidthPackageIdstring

The ID of the bandwidth plan.

cenbwp-uenczwb592fnvv****
OppositeRegionIdstring

The ID of the peer region.

cn-hangzhou
GeographicSpanIdstring

The IDs of the local and peer regions.

china_china
CenIdstring

The CEN instance ID.

cen-pfa6ugf3xl0qsd****
LocalRegionIdstring

The ID of the local region.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

ccn-cn-shanghai
BandwidthLimitlong

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

1
BandwidthTypestring

The bandwidth allocation method. Valid values:

  • BandwidthPackage: allocates bandwidth from a bandwidth plan.
  • DataTransfer: bandwidth is billed based on the pay-by-data-transfer metering method.
BandwidthPackage

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "7A30C665-8766-5AAA-9274-C97380E2D850",
  "PageNumber": 1,
  "TotalCount": 1,
  "CenInterRegionBandwidthLimits": {
    "CenInterRegionBandwidthLimit": [
      {
        "Status": "Active",
        "BandwidthPackageId": "cenbwp-uenczwb592fnvv****",
        "OppositeRegionId": "cn-hangzhou",
        "GeographicSpanId": "china_china",
        "CenId": "cen-pfa6ugf3xl0qsd****",
        "LocalRegionId": "ccn-cn-shanghai",
        "BandwidthLimit": 1,
        "BandwidthType": "BandwidthPackage"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
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-05-17The response structure of the API has changedView Change Details
2023-07-07The request parameters of the API has changedView Change Details