Queries the information about bandwidth plans.
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 Resourcesis 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:DescribeCenBandwidthPackages | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| IncludeReservationData | boolean | No | Specifies whether to include renewal data. Valid values:
| true |
| 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. Maximum value: 50. Default value: 10. | 2 |
| IsOrKey | boolean | No | The logical operator between the filter conditions. Valid values:
| false |
| ResourceGroupId | string | No | The ID of the resource group. | rg-acfnwjeo4tv**** |
| Filter | array<object> | No | The filter configurations. | |
| object | No | |||
| Key | string | No | The filter conditions. You can use filter conditions to filter the bandwidth plans that you want to query. The following filter conditions are supported:
| CenId |
| Value | array | No | Specify a filter value based on the Key parameter. You can specify multiple filter values for each Key. The logical operator between filter values is OR. If one filter value is matched, the filter condition is matched. | |
| string | No | Specify a filter value based on the Key parameter. You can specify multiple filter values for each Key. The logical operator between filter values is OR. If a bandwidth plan matches one of the filter values, the bandwidth plan is a match. | cen-xxjsjfkffkfkfjkf**** | |
| Tag | array<object> | No | The information about the tags. You can specify at most 20 tags in each call. | |
| object | No | |||
| Key | string | No | The tag keys. The tag keys cannot be an empty string. The tag keys can be up to 64 characters in length and cannot start with You can specify at most 20 tag keys. | TagKey |
| Value | string | No | The tag values. The tag values can be 0 to 128 characters in length, and cannot start with The tag value of each tag key must be unique. You can specify at most 20 tag values in each call. | TagValue |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 2,
"RequestId": "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
"PageNumber": 1,
"TotalCount": 2,
"CenBandwidthPackages": {
"CenBandwidthPackage": [
{
"ReservationActiveTime": "2021-08-30T16:00Z",
"Status": "InUse",
"CreationTime": "2021-02-01T11:14Z",
"ReservationOrderType": "UPGRADE",
"BandwidthPackageChargeType": "PREPAY",
"CenBandwidthPackageId": "cenbwp-4c2zaavbvh5x****",
"ReservationInternetChargeType": "PREPAY",
"GeographicRegionAId": "china",
"Bandwidth": 2,
"Description": "cen",
"ExpiredTime": "2021-09-08T16:00Z",
"ReservationBandwidth": "10",
"GeographicSpanId": "north-america_china",
"GeographicRegionBId": "north-america",
"ResourceGroupId": "rg-aekzoyr5k36****",
"IsCrossBorder": false,
"BusinessStatus": "Normal",
"Name": "test",
"HasReservationData": "false",
"OrginInterRegionBandwidthLimits": {
"OrginInterRegionBandwidthLimit": [
{
"BandwidthLimit": "1",
"OppositeRegionId": "us-west-1",
"GeographicSpanId": "north-america_china",
"LocalRegionId": "cn-hangzhou"
}
]
},
"Tags": {
"Tag": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
},
"CenIds": {
"CenId": [
"cen-xxjsjfkffkfkfjkf****"
]
}
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IllegalParam.TagValue | The tag values are not valid. | The error message returned because the specified tag value is invalid. |
| 400 | IllegalParam.TagKey | The tag keys are not valid. | The error message returned because the specified tag key is invalid. |
| 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.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-03-08 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |