調用DescribeCenBandwidthPackages介面查詢頻寬包執行個體的資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
cen:DescribeCenBandwidthPackages |
get |
*CenBandwidthPackage
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
|
IncludeReservationData |
boolean |
否 |
是否包含續約資料,取值:
|
true |
|
PageNumber |
integer |
否 |
列表的頁碼,預設值為 1。 |
1 |
|
PageSize |
integer |
否 |
分頁查詢時每頁的行數,最大值為 50,預設值為 10。 |
2 |
|
IsOrKey |
boolean |
否 |
過濾條件之間的關係,取值:
|
false |
|
ResourceGroupId |
string |
否 |
資源群組 ID。 |
rg-acfnwjeo4tv**** |
|
Filter |
array |
否 |
過濾資訊 |
|
|
object |
否 |
過濾資訊 |
||
|
Key |
string |
否 |
過濾條件。 您可以通過過濾條件式篩選要查看的頻寬包執行個體。系統支援以下過濾條件:
|
CenId |
|
Value |
array |
否 |
根據 Key 指定過濾值。一個 Key 支援指定多個過濾值,每個過濾值之間是或的關係,即只要符合其中一個過濾值,則視為匹配該過濾條件。 |
Idle |
|
string |
否 |
根據 Key 指定過濾值。 一個 Key 支援指定多個過濾值,每個過濾值之間是或的關係,即只要符合其中一個過濾值,則視為匹配該過濾條件。 |
cen-xxjsjfkffkfkfjkf**** |
|
|
Tag |
array |
否 |
標籤資訊列表。 一次最多支援輸入 20 個標籤資訊。 |
|
|
object |
否 |
標籤資訊。 一次最多支援輸入 20 個標籤資訊。 |
||
|
Key |
string |
否 |
資源的標籤鍵。 一旦傳入該值,則不允許為空白字串。最多支援 64 個字元,不能以 一次最多支援輸入 20 個標籤的標籤鍵。 |
TagKey |
|
Value |
string |
否 |
資源的標籤值。 標籤值可以為空白或輸入不超過 128 個字元的字串,不能以 每一個標籤鍵對應一個標籤值,一次最多支援輸入 20 個標籤鍵對應的標籤值。 |
TagValue |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| PageSize |
integer |
每頁包含的條目數。 |
2 |
| RequestId |
string |
請求 ID。 |
9D7E2400-2755-4AF5-9B73-12565E4F73A0 |
| PageNumber |
integer |
當前頁碼。 |
1 |
| TotalCount |
integer |
列表條目數。 |
2 |
| CenBandwidthPackages |
object |
||
| CenBandwidthPackage |
array |
頻寬包的詳細資料。 |
|
|
object |
|||
| ReservationActiveTime |
string |
臨時升配到期時間。 |
2021-08-30T16:00Z |
| Status |
string |
頻寬包是否已綁定雲企業網執行個體。
|
InUse |
| CreationTime |
string |
頻寬包的建立時間,採用 ISO8601 格式表示,格式為:YYYY-MM-DDThh:mmZ。 |
2021-02-01T11:14Z |
| ReservationOrderType |
string |
續約變更配置方式。
|
UPGRADE |
| BandwidthPackageChargeType |
string |
頻寬包的計費方式。 |
PREPAY |
| CenBandwidthPackageId |
string |
頻寬包的 ID。 |
cenbwp-4c2zaavbvh5x**** |
| ReservationInternetChargeType |
string |
變更配置之後的計費方式。 |
PREPAY |
| GeographicRegionAId |
string |
要查詢的地區 ID。取值:
|
china |
| Bandwidth |
integer |
頻寬包的峰值頻寬。 |
2 |
| Description |
string |
頻寬包描述。 |
cen |
| ExpiredTime |
string |
頻寬包逾時時間。 |
2021-09-08T16:00Z |
| ReservationBandwidth |
string |
臨時升配結束後恢複的頻寬。 |
10 |
| GeographicSpanId |
string |
地區對應的 ID。 |
north-america_china |
| GeographicRegionBId |
string |
頻寬包執行個體的另一個互連地區 ID。取值:
|
north-america |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-aekzoyr5k36**** |
| IsCrossBorder |
boolean |
是否是跨境頻寬包。
|
false |
| BusinessStatus |
string |
頻寬包的狀態。
|
Normal |
| Name |
string |
頻寬包的名稱。 |
test |
| HasReservationData |
string |
是否有續約資料。
說明
僅入參 IncludeReservationData 取值為 true,且有未生效訂購資料時才會為 true。 |
false |
| OrginInterRegionBandwidthLimits |
object |
||
| OrginInterRegionBandwidthLimit |
array |
互連地區的詳細資料。 |
|
|
object |
|||
| BandwidthLimit |
string |
互連地區間的頻寬峰值。 |
1 |
| OppositeRegionId |
string |
對端地區 ID。 |
us-west-1 |
| GeographicSpanId |
string |
互連地區。 |
north-america_china |
| LocalRegionId |
string |
本端地區 ID。 |
cn-hangzhou |
| Tags |
object |
||
| Tag |
array |
頻寬包的標籤資訊。 |
|
|
object |
標籤列表。 |
||
| Key |
string |
標籤鍵。 |
TagKey |
| Value |
string |
標籤值。 |
TagValue |
| CenIds |
object |
||
| CenId |
array |
頻寬包對應的雲企業網執行個體的列表。 |
|
|
string |
頻寬包對應的雲企業網執行個體 ID。 |
cen-xxjsjfkffkfkfjkf**** |
樣本
正常返回樣本
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. | 帳號無許可權操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。