調用DescribeCenBandwidthPackages接口查詢帶寬包實例的信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:DescribeCenBandwidthPackages | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
IncludeReservationData | boolean | 否 | 是否包含續費數據,取值:
| true |
PageNumber | integer | 否 | 列表的頁碼,默認值為 1。 | 1 |
PageSize | integer | 否 | 分頁查詢時每頁的行數,最大值為 50,默認值為 10。 | 2 |
IsOrKey | boolean | 否 | 過濾條件之間的關系,取值:
| false |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfnwjeo4tv**** |
Filter | array<object> | 否 | 過濾信息 | |
object | 否 | 過濾信息 | ||
Key | string | 否 | 過濾條件。 您可以通過過濾條件篩選要查看的帶寬包實例。系統支持以下過濾條件:
| CenId |
Value | array | 否 | 根據 Key 指定過濾值。一個 Key 支持指定多個過濾值,每個過濾值之間是或的關系,即只要符合其中一個過濾值,則視為匹配該過濾條件。 | |
string | 否 | 根據 Key 指定過濾值。 一個 Key 支持指定多個過濾值,每個過濾值之間是或的關系,即只要符合其中一個過濾值,則視為匹配該過濾條件。 | cen-xxjsjfkffkfkfjkf**** | |
Tag | array<object> | 否 | 標簽信息列表。 一次最多支持輸入 20 個標簽信息。 | |
object | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | ||
Key | string | 否 | 資源的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標簽鍵對應一個標簽值,一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
返回參數
示例
正常返回示例
JSON
格式
{
"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****"
]
}
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.TagValue | The tag values are not valid. | 參數中指定的tag value不合法。 |
400 | IllegalParam.TagKey | The tag keys are not valid. | 參數中指定的tag key不合法。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-03-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |