Queries the unused bandwidth of a bandwidth plan.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeCenGeographicSpanRemainingBandwidth

The operation that you want to perform. Set the value to DescribeCenGeographicSpanRemainingBandwidth.

CenId String Yes cen-nh98vzx8gfhlwn****

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

GeographicRegionAId String Yes China

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

  • China: mainland China
  • North-America: North America
  • Asia-Pacific: Asia Pacific
  • Europe: Europe
  • Australia: Australia
GeographicRegionBId String Yes North-America

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

  • China: mainland China
  • North-America: North America
  • Asia-Pacific: Asia Pacific
  • Europe: Europe
  • Australia: Australia
PageNumber Integer No 1

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

PageSize Integer No 10

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

Response parameters

Parameter Type Example Description
RemainingBandwidth Long 2

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

RequestId String E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCenGeographicSpanRemainingBandwidth
&CenId=cen-nh98vzx8gfhlwn****
&GeographicRegionAId=China
&GeographicRegionBId=North-America
&<Common request parameters>

Sample success responses

XML format 

<DescribeCenGeographicSpanRemainingBandwidthResponse>
      <RequestId>E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B</RequestId>
      <RemainingBandwidth>2</RemainingBandwidth>
</DescribeCenGeographicSpanRemainingBandwidthResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.