帯域幅パッケージインスタンスの情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cen:DescribeCenBandwidthPackages |
get |
*CenBandwidthPackage
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| IncludeReservationData |
boolean |
任意 |
更新データを含めるかどうかを指定します。有効な値:
|
true |
| PageNumber |
integer |
任意 |
リストのページ番号。デフォルト値: 1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリの 1 ページあたりのエントリ数。最大値: 50。デフォルト値: 10。 |
2 |
| IsOrKey |
boolean |
任意 |
フィルター条件間の論理関係。有効な値:
|
false |
| ResourceGroupId |
string |
任意 |
リソースグループの ID。 |
rg-acfnwjeo4tv**** |
| Filter |
array<object> |
任意 |
フィルター情報。 |
|
|
object |
任意 |
フィルター情報。 |
||
| Key |
string |
任意 |
フィルター条件。 フィルター条件を使用して、クエリする帯域幅パッケージインスタンスを絞り込むことができます。以下のフィルター条件がサポートされています。
|
CenId |
| Value |
array |
任意 |
指定された Key に基づくフィルター値。単一の Key に対して複数のフィルター値を指定できます。フィルター値は OR 関係であり、いずれかのフィルター値に一致する帯域幅パッケージがそのフィルター条件に一致するとみなされます。 |
Idle |
|
string |
任意 |
指定された Key に基づくフィルター値。 単一の Key に対して複数のフィルター値を指定できます。フィルター値は OR 関係であり、いずれかのフィルター値に一致する帯域幅パッケージがそのフィルター条件に一致するとみなされます。 |
cen-xxjsjfkffkfkfjkf**** |
|
| Tag |
array<object> |
任意 |
タグ情報リスト。 一度に最大 20 個のタグを指定できます。 |
|
|
object |
任意 |
タグ情報。 一度に最大 20 個のタグを指定できます。 |
||
| Key |
string |
任意 |
リソースのタグキー。 指定する場合、タグキーを空文字列にすることはできません。タグキーの長さは最大 64 文字で、 一度に最大 20 個のタグキーを指定できます。 |
TagKey |
| Value |
string |
任意 |
リソースのタグ値。 タグ値は空、または最大 128 文字の文字列とすることができます。 各タグキーは 1 つのタグ値に対応します。一度に最大 20 個のタグ値を指定できます。 |
TagValue |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageSize |
integer |
1 ページあたりのエントリ数。 |
2 |
| RequestId |
string |
リクエスト ID。 |
9D7E2400-2755-4AF5-9B73-12565E4F73A0 |
| PageNumber |
integer |
現在のページ番号。 |
1 |
| TotalCount |
integer |
エントリの総数。 |
2 |
| CenBandwidthPackages |
object |
||
| CenBandwidthPackage |
array<object> |
帯域幅パッケージの詳細。 |
|
|
array<object> |
|||
| ReservationActiveTime |
string |
一時的なアップグレードの有効期限時間。ISO 8601 フォーマット (YYYY-MM-DDThh:mmZ) で表示されます。 |
2021-08-30T16:00Z |
| Status |
string |
帯域幅パッケージが CEN インスタンスに関連付けられているかどうかを示します。
|
InUse |
| CreationTime |
string |
帯域幅パッケージの作成時間。ISO 8601 フォーマット (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 |
帯域幅パッケージの有効期限時間。ISO 8601 フォーマット (YYYY-MM-DDThh:mmZ) で表示されます。 |
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> |
相互通信リージョンの詳細。 |
|
|
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> |
帯域幅パッケージのタグ情報。 |
|
|
object |
タグリスト。 |
||
| Key |
string |
タグキー。 |
TagKey |
| Value |
string |
タグ値。 |
TagValue |
| CenIds |
object |
||
| CenId |
array |
帯域幅パッケージに関連付けられている CEN インスタンスのリスト。 |
|
|
string |
帯域幅パッケージに関連付けられている CEN インスタンスのインスタンス ID。 |
cen-xxjsjfkffkfkfjkf**** |
例
成功レスポンス
JSONJSON
{
"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": "法線",
"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 ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.TagValue | The tag values are not valid. | リクエストで指定されたタグ値が無効です。 |
| 400 | IllegalParam.TagKey | The tag keys are not valid. | リクエストで指定されたタグキーが無効です。 |
| 400 | InvalidParameter | Invalid parameter. | パラメーターが無効です。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | アカウントにこの操作を実行する権限がありません。 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。