この操作では、帯域幅プランに関する情報を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK に用意されている API のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
Action String 必須 DescribeBandwidthPackage

実行する操作です。 値を DescribeBandwidthPackage に設定します。

BandwidthPackageId String 必須 gbwp-bp1sgzldyj6b4q7cx****

照会する帯域幅プランの ID です。

RegionId String 必須 cn-hangzhou

Global Accelerator インスタンスの属するリージョンの ID です。 この値を cn-hangzhou に設定します。

レスポンスパラメーター

パラメーター データ型 説明
Accelerators List ga-bp1qe94o52ot4pkfn****

帯域幅プランに関連付けられている Global Accelerator インスタンスの ID です。

Bandwidth Integer 2

帯域幅プランによって提供される帯域幅です。

BandwidthPackageId String gbwp-bp1sgzldyj6b4q7cx****

帯域幅プランの ID です。

BandwidthType String Basic

帯域幅プランのタイプです。 有効な値:

  • Basic :標準の高速化帯域幅
  • Enhanced :拡張高速化帯域幅
  • Advanced :高度な高速化帯域幅
CbnGeographicRegionIdA String China-mainland

クロスボーダー帯域幅プランで定義されたエリア A です。

このパラメーターは、中国本土外のリージョンにデプロイされているインスタンスを照会した後にのみ返されます。

CbnGeographicRegionIdB String Global

クロスボーダー帯域幅プランで定義されたエリア B です。

このパラメーターは、中国本土外のリージョンにデプロイされているインスタンスを照会した後にのみ返されます。

ChargeType String PREPAY

帯域幅プランの課金方法です。 値は PREPAY のみがサポートされています。 この値は、サブスクリプションを示します。

CreateTime String 1578966918000

帯域幅プランが作成された時刻です。

Description String testDescription

帯域幅プランの説明です。

ExpiredTime String 1578966918000

帯域幅プランの失効時刻です。

Name String testName

帯域幅プランの名前です。

RegionId Boolean cn-hangzhou

Global Accelerator インスタンスのリージョン ID です。

RequestId String 4B6DBBB0-2D01-4C6A-A384-4129266E6B78

リクエストの ID です。

State String active

帯域幅プランのステータスです。 有効な値:

  • init:帯域幅プランを初期化しています。
  • active:帯域幅プランが利用可能です。
  • binded:帯域幅プランは、Global Accelerator インスタンスにバインド済みです。
  • binding:帯域幅プランは、Global Accelerator インスタンスにバインド中です。
  • unbinding:帯域幅プランは、Global Accelerator インスタンスのバインドを解除中です。
  • updating:帯域幅プランを更新中です。
  • finacialLocked:料金滞納のため、帯域幅プランはロックされています。
Type String Basic

帯域幅プランのタイプです。 有効な値:

  • Basic:基本的な帯域幅プラン
  • CrossDomain :クロスボーダー帯域幅プラン

中国サイトでは、Basic のみがサポートされています。

リクエスト例

http(s)://[Endpoint]/? Action=DescribeBandwidthPackage
&BandwidthPackageId=gbwp-bp1sgzldyj6b4q7cx****
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式

<DescribeBandwidthPackageResponse>
      <ChargeType>PREPAY</ChargeType>
      <Name>testName</Name>
      <Description>testDescription</Description>
      <BandwidthPackageId>gbwp-bp1sgzldyj6b4q7cx****</BandwidthPackageId>
      <State>active</State>
      <RegionId>cn-hangzhou</RegionId>
      <CreateTime>1578966918000</CreateTime>
      <RequestId>4B6DBBB0-2D01-4C6A-A384-4129266E6B78</RequestId>
      <Bandwidth>2</Bandwidth>
</DescribeBandwidthPackageResponse>

JSON 形式

{
  "ChargeType": "PREPAY",
  "Name": "testName",
  "Description": "testDescription",
  "BandwidthPackageId": "gbwp-bp1sgzldyj6b4q7cx****",
  "State": "active",
  "RegionId": "cn-hangzhou",
  "CreateTime": 1578966918000,
  "RequestId": "4B6DBBB0-2D01-4C6A-A384-4129266E6B78",
  "Bandwidth": 2
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。