この API を呼び出して、特定の条件に一致する帯域幅プランを照会できます。

デバッグ

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

リクエストパラメーター

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

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

RegionId String 必須 cn-hangzhou

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

PageNumber String 任意 1

返されるページ数。 デフォルト値:1

PageSize String 任意 10

返される各ページのエントリ数。 設定可能な値:1〜100。 デフォルト値:10。

State String 任意 active

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

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

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

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

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

レスポンスパラメーター

パラメーター データ型 説明
BandwidthPackages Array

返された帯域幅プランの詳細。

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。

State String active

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

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

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

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

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

PageNumber Integer 1

返されたページ数。

PageSize Integer 10

返される 1 ページあたりのエントリ数。

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

リクエストの ID。

TotalCount Integer 10

返されたエントリの総数。

リクエスト例

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

通常のレスポンス例

XML 形式

<ListBandwidthPackagesResponse>
  <PageNumber>10</PageNumber>
  <TotalCount>6</TotalCount>
  <BandwidthPackages>
        <ChargeType>PREPAY</ChargeType>
        <BandwidthPackageId>gbwp-bp1pa01cgpfv3v4ti****</BandwidthPackageId>
        <State>binded</State>
        <RegionId>cn-hangzhou</RegionId>
        <CreateTime>1581598782000</CreateTime>
        <Accelerators>ga-bp1e98ijosxvu3vgb****</Accelerators>
        <ExpiredTime>1584115200000</ExpiredTime>
        <Bandwidth>3</Bandwidth>
  </BandwidthPackages>
  <BandwidthPackages>
        <ChargeType>PREPAY</ChargeType>
        <BandwidthPackageId>gbwp-bp1d8xk8bg139j0fw****</BandwidthPackageId>
        <State>binded</State>
        <RegionId>cn-hangzhou</RegionId>
        <CreateTime>1581608370000</CreateTime>
        <Accelerators>ga-bp1j80t5gulpwx12r****</Accelerators>
        <ExpiredTime>1584115200000</ExpiredTime>
        <Bandwidth>2</Bandwidth>
  </BandwidthPackages>
  <PageSize>10</PageSize>
  <RequestId>7BDAA1C7-9794-4703-A26F-9E8E13594DF3</RequestId>
</ListBandwidthPackagesResponse>

JSON 形式

{
  "PageNumber": 10,
  "TotalCount": 6,
  "BandwidthPackages": [
    {
      "ChargeType": "PREPAY",
      "BandwidthPackageId": "gbwp-bp1pa01cgpfv3v4ti****",
      "State": "binded",
      "RegionId": "cn-hangzhou",
      "CreateTime": 1581598782000,
      "Accelerators": [
        "ga-bp1e98ijosxvu3vgb****"
      ],
      "ExpiredTime": 1584115200000,
      "Bandwidth": 3
    },
    {
      "ChargeType": "PREPAY",
      "BandwidthPackageId": "gbwp-bp1d8xk8bg139j0fw****",
      "State": "binded",
      "RegionId": "cn-hangzhou",
      "CreateTime": 1581608370000,
      "Accelerators": [
        "ga-bp1j80t5gulpwx12r****"
      ],
      "ExpiredTime": 1584115200000,
      "Bandwidth": 2
    }
  ],
  "PageSize": 10,
  "RequestId": "7BDAA1C7-9794-4703-A26F-9E8E13594DF3"
}

エラーコード

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