調用DescribeCommonBandwidthPackages接口查詢指定地域中共享帶寬實例列表及其信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:DescribeCommonBandwidthPackages | get | *CommonBandwidthPackage acs:vpc:{#regionId}:{#accountId}:combandwidthpackage/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IncludeReservationData | boolean | 否 | 是否包含未生效的訂購數據。取值：
| false |
| RegionId | string | 是 | 共享帶寬所在的地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| BandwidthPackageId | string | 否 | 共享帶寬實例的 ID。 | cbwp-2ze2ic1xd2qeqk145**** |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmxazb4ph**** |
| Name | string | 否 | 共享帶寬實例名稱。
長度為 0-128 個字符，不能以 | test123 |
| PageNumber | integer | 否 | 列表的頁碼。默認值：1。 | 1 |
| PageSize | integer | 否 | 分頁查詢時每頁的行數。最大值：50。默認值：10。 | 10 |
| DryRun | boolean | 否 | 是否只預檢此次請求。取值：
| false |
| Tag | array<object> | 否 | 共享帶寬實例的標簽列表。 | |
| object | 否 | 共享帶寬實例的標簽列表。 | ||
| Key | string | 否 | 資源的標簽鍵。最多支持輸入 20 個標簽鍵。如需傳入該值，則不能輸入空字符串。 一個標簽鍵最多支持 128 個字符，不能以 | KeyTest |
| Value | string | 否 | 資源的標簽值。最多支持輸入 20 個標簽值。如需傳入該值，可以輸入空字符串。 最多支持 128 個字符，不能以 | ValueTest |
| SecurityProtectionEnabled | boolean | 否 | 是否開啟 DDoS 防護（增強版）。取值：
說明
該參數已廢棄。
| false |
返回參數
示例
正常返回示例
JSON格式
{
"PageSize": 10,
"RequestId": "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33",
"PageNumber": 1,
"TotalCount": 1,
"CommonBandwidthPackages": {
"CommonBandwidthPackage": [
{
"ReservationActiveTime": "2018-08-30T16:00:00Z",
"Status": "Available",
"CreationTime": "2017-06-28T06:39:20Z",
"ReservationOrderType": "RENEWCHANGE",
"DeletionProtection": true,
"ReservationInternetChargeType": "PayByBandwidth",
"Ratio": 20,
"InstanceChargeType": "PostPaid",
"RegionId": "cn-hangzhou",
"BandwidthPackageId": "cbwp-bp1t3sm1ffzmshdki****",
"ServiceManaged": 1,
"Bandwidth": "20",
"Description": "none",
"ExpiredTime": "2019-01-15T03:08:37Z",
"ReservationBandwidth": "1000",
"ResourceGroupId": "rg-acfmxazb4ph****",
"InternetChargeType": "PayByBandwidth",
"BusinessStatus": "Normal",
"Name": "abc",
"ISP": "BGP",
"HasReservationData": "false",
"PublicIpAddresses": {
"PublicIpAddresse": [
{
"IpAddress": "47.95.XX.XX",
"AllocationId": "eip-bp13e9i2qst4g6jzi****",
"BandwidthPackageIpRelationStatus": "BINDED"
}
]
},
"SecurityProtectionTypes": {
"SecurityProtectionType": [
"AntiDDoS_Enhanced"
]
},
"Tags": {
"Tag": [
{
"Key": "KeyTest",
"Value": "ValueTest"
}
]
},
"BizType": "CloudBox",
"Zone": "ap-southeast-1-lzdvn-cb"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidBandwidthPackageIdNumber.NotSupported | The number of BandwidthPackageIds exceeds the limit. | 共享帶寬包的數量超過Quota限制。 |
| 400 | InvalidResourceGroupId | The specified ResourceGroupId does not exist. | 資源組ID不存在。 |
| 400 | OperationUnsupported.ResourceGroupId | ResourceGroup is not supported in this region. | 資源組功能未打開。 |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-08 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-06-12 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-05-17 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |