現在のAlibaba Cloudアカウント内のCloud Enterprise Network (CEN) 帯域幅プランの詳細を照会します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
IncludeReservationData Boolean 任意 true

更新データを含めるかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: はい
  • false: いいえ
操作 String 必須 DescribeCenBandwidthPackages

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

PageNumber Integer 任意 1

返されるページ数。 既定値：1

PageSize Integer 任意 2

各ページで返されるエントリ数。 最大値：50。 既定値：10。

IsOrKey Boolean 任意 false

フィルター条件間の論理演算子。 設定可能な値は以下のとおりです。

  • false (デフォルト): すべてのフィルタ条件を満たすAND帯域幅プランが返されます。
  • true: ORフィルター条件の1つを満たす帯域幅プランが返されます。
Filter.N.Key String 任意 CenId

The filter condition.

フィルター条件を使用して、クエリする帯域幅プランをフィルター処理できます。 次のフィルター条件がサポートされています。

  • CenId: CENインスタンスID
  • Status: bandwidth plan status. 設定可能な値は以下のとおりです。
    • Idle: CENインスタンスに関連付けられていません。
    • InUse: CENインスタンスに関連付けられています。
  • CenBandwidthPackageId: 帯域幅プランID

  • Name: bandwidth plan name

    1つ以上のフィルター条件を指定できます。 Nの最大値は5である。

Filter.N.Value.N String 任意 cen-xxjsjfkffkfkfjkf ****

Keyパラメーターに基づいてフィルター値を指定します。

フィルターキーには複数の値を指定できます。 複数のフィルタ値間の論理関係はORである。 帯域幅パッケージが指定した値のいずれかと一致する場合、帯域幅パッケージはフィルター条件と一致します。

レスポンスパラメーター

パラメーター データ型 例 説明
PageSize Integer 2

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

RequestId String 9D7E2400-2755-4AF5-9B73-12565E4F73A0

リクエストの ID です。

PageNumber Integer 1

返されたページの数です。

TotalCount Integer 2

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

CenBandwidthパッケージ CenBandwidthPackageの配列

帯域幅プランの詳細。

CenBandwidthPackage
ReservationActiveTime String 2021-08-30T16:00Z

一時的なアップグレードの有効期限。

ステータス String 使用中

帯域幅プランがCENインスタンスに関連付けられているかどうかを示します。

  • アイドル: いいえ
  • InUse: はい
CreationTime String 2021-02-01T11:14Z

帯域幅プランが作成された時刻。 時刻はISO8601標準でYYYY-MM-DDThh:mmZ形式で表示されます。

ReservationOrderType String UPGRADE

更新方法。

  • TEMP_UPGRADE: 一時的なアップグレード
  • アップグレード: アップグレード
BandwidthPackageChargeType String PREPAY

帯域幅プランの請求方法。

CenBandwidthPackageId String cenbwp-4c2zaavbvh5x ****

帯域幅プランの ID。

ReservationInternetChargeType String PREPAY

新しい課金方法。

GeographicRegionAId String china

照会するエリアのID。 設定可能な値は以下のとおりです。

  • china: 中国本土。
  • アジア太平洋
  • ヨーロッパ: ヨーロッパ
  • オーストラリア: オーストラリア
  • 北アメリカ
帯域幅 Long 2

帯域幅プランの最大帯域幅。

説明 String cen

帯域幅プランの説明。

ExpiredTime String 2021-09-08T16:00Z

帯域幅プランのタイムアウト期間。

ReservationBandwidth String 10

一時的なアップグレードが終了したときに帯域幅プランがロールバックされる帯域幅の値。

GeographicSpanId String north-america_china

接続エリアのID。

GeographicRegionBId String 北アメリカ

帯域幅プランの他の接続エリアのID。 設定可能な値は以下のとおりです。

  • china: 中国本土。
  • アジア太平洋
  • ヨーロッパ: ヨーロッパ
  • オーストラリア: オーストラリア
  • 北アメリカ
IsCrossBorder Boolean false

帯域幅プランがクロスボーダー帯域幅プランであるかどうかを示します。

  • false: いいえ
  • true: はい
BusinessStatus String 通常

帯域幅プランのステータス。 設定可能な値は以下のとおりです。

  • Normal: 正常
  • FinancialLocked: 延滞支払いのためにロックされました
  • SecurityLocked: セキュリティ上の理由によるロック
パラメーター名 String test

帯域幅プランの名前。

HasReservationData String false

更新データが含まれるかどうかを示します。

  • true: はい
  • false: いいえ
説明 このパラメーターは、IncludeReservationDataパラメーターがtrueに設定され、注文が有効になっていない場合にのみtrueを返します。
OrginInterRegionBandwidthLimits OrginInterRegionBandwidthLimitの配列

接続されているリージョンの詳細。

OrginInterRegionBandwidthLimit
帯域幅制限 String 1

リージョン間接続の最大帯域幅の値。

OppositeRegionId String us-west-1

ピアリージョンのID。

GeographicSpanId String north-america_china

接続されたリージョン。

LocalRegionId String cn-hangzhou

ソースリージョンのID。

CenIds 文字列の配列 cen-xxjsjfkffkfkfjkf ****

帯域幅プランに関連付けられているCENインスタンスのリスト。

例

リクエストの例

http(s):// [エンドポイント]/?IncludeReservationData=true
&アクション=DescribeCenBandwidthパッケージ
&PageNumber=1
&PageSize=2
&IsOrKey=false
&Filter=[{"Key":"CenId","Value":["cen-xxjsjfkffkfkfkfjkf ****"]}]
&共通リクエストパラメータ

レスポンスの例

XML 形式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCenBandwidthPackagesResponse>
    <PageSize>2</PageSize>
    <RequestId>9D7E2400-2755-4AF5-9B73-12565E4F73A0</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <CenBandwidthPackages>
        <ReservationActiveTime>2021-08-30T16:00Z</ReservationActiveTime>
        <Status>InUse</Status>
        <CreationTime>2021-02-01T11:14Z</CreationTime>
        <ReservationOrderType>UPGRADE</ReservationOrderType>
        <BandwidthPackageChargeType>PREPAY</BandwidthPackageChargeType>
        <CenBandwidthPackageId>cenbwp-4c2zaavbvh5x ****</CenBandwidthPackageId>
        <ReservationInternetChargeType>PREPAY</ReservationInternetChargeType>
        <GeographicRegionAId> 中国 </GeographicRegionAId>
        <Bandwidth>2</Bandwidth>
        <Description>cen</Description>
        <ExpiredTime>2021-09-08T16:00Z</ExpiredTime>
        <ReservationBandwidth>10</ReservationBandwidth>
        <GeographicSpanId>north-america_china</GeographicSpanId>
        <GeographicRegionBId> 北米 </GeographicRegionBId>
        <IsCrossBorder>false</IsCrossBorder>
        <BusinessStatus>Normal</BusinessStatus>
        <名前> テスト </名前>
        <HasReservationData>false</HasReservationData>
        <OrginInterRegionBandwidthLimits>
            <BandwidthLimit>1</BandwidthLimit>
            <OppositeRegionId>us-west-1</OppositeRegionId>
            <GeographicSpanId>north-america_china</GeographicSpanId>
            <LocalRegionId>cn-hangzhou</LocalRegionId>
        </OrginInterRegionBandwidthLimits>
        <CenIds>cen-xxjsjfkffkfkfjkf ****</CenIds>
    </CenBandwidthPackages>
</DescribeCenBandwidthPackagesResponse>

JSON 形式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 2、
  "RequestId" : "9D7E2400-2755-4AF5-9B73-12565E4F73A0" 、
  "PageNumber" : 1,
  "TotalCount" : 2,
  "CenBandwidthPackages" : [ {
    "ReservationActiveTime" : "2021-08-30T16:00Z" 、
    "ステータス" : "InUse" 、
    "CreationTime" : "2021-02-01T11:14Z" 、
    "ReservationOrderType" : "UPGRADE" 、
    "BandwidthPackageChargeType" : "PREPAY" 、
    "CenBandwidthPackageId" : "cenbwp-4c2zaavbvh5x ****" 、
    "ReservationInternetChargeType" : "PREPAY" 、
    "GeographicRegionAId" : "中国" 、
    "帯域幅" : 2、
    "Description" : "cen" 、
    "ExpiredTime" : "2021-09-08T16:00Z" 、
    "ReservationBandwidth" : "10" 、
    "GeographicSpanId" : "north-america_china" 、
    "GeographicRegionBId" : "北アメリカ" 、
    "IsCrossBorder" : false、
    "BusinessStatus" : "Normal" 、
    "名前" : "テスト" 、
    "HasReservationData" : "false" 、
    "OrginInterRegionBandwidthLimits" : [ {
      "BandwidthLimit" : "1" 、
      "OppositeRegionId" : "us-west-1" 、
      "GeographicSpanId" : "north-america_china" 、
      "LocalRegionId" : "cn-hangzhou"
    } ],
    "CenIds" : [ "cen-xxjsjfkffkfkfkfjkf ****"]
  } ]
}

エラーコード

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