Queries the remaining bandwidth of a bandwidth plan.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
cen:DescribeCenGeographicSpanRemainingBandwidth | get | *CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
PageNumber | integer | No | The number of the page to return. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Default value: 10. Valid values: 1 to 50. | 10 |
CenId | string | Yes | The ID of the Cloud Enterprise Network (CEN) instance to which the bandwidth plan is associated. | cen-nh98vzx8gfhlwn**** |
GeographicRegionAId | string | Yes | The ID of one of the connected areas of the bandwidth plan. Valid values:
| China |
GeographicRegionBId | string | Yes | The ID of the other area connected by the bandwidth plan. Valid values:
| North-America |
Response parameters
Examples
Sample success responses
JSON
format
{
"RemainingBandwidth": 2,
"RequestId": "E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
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. |
For a list of error codes, visit the Service error codes.