All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenGeographicSpanRemainingBandwidth

Last Updated:Oct 22, 2024

Queries the remaining bandwidth of a bandwidth plan.

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:DescribeCenGeographicSpanRemainingBandwidthget
  • 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
CenIdstringYes

The ID of the Cloud Enterprise Network (CEN) instance to which the bandwidth plan is associated.

cen-nh98vzx8gfhlwn****
GeographicRegionAIdstringYes

The ID of one of the connected areas of the bandwidth plan. Valid values:

  • China: Chinese mainland
  • North-America: North America
  • Asia-Pacific: Asia Pacific
  • Europe: Europe
  • Australia: Australia
China
GeographicRegionBIdstringYes

The ID of the other area connected by the bandwidth plan. Valid values:

  • China: Chinese mainland
  • North-America: North America
  • Asia-Pacific: Asia Pacific
  • Europe: Europe
  • Australia: Australia
North-America

Response parameters

ParameterTypeDescriptionExample
object
RemainingBandwidthlong

The remaining bandwidth of the bandwidth plan. Unit: Mbit/s.

2
RequestIdstring

The ID of the request.

E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B

Examples

Sample success responses

JSONformat

{
  "RemainingBandwidth": 2,
  "RequestId": "E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B"
}

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.