特定のリージョンのEIP帯域幅プランを照会します。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DescribeCommonBandwidthPackages

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

IncludeReservationData Boolean 任意 false

保留中の注文を返すかどうかを指定します。 設定可能な値は以下のとおりです。

  • false: いいえ。 デフォルト値です。
  • true: はい
RegionId String 必須 cn-hangzhou

EIP帯域幅プランのリージョンID。

DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

BandwidthPackageId String 任意 cbwp-2ze2ic1xd2qeqk145****

EIP帯域幅プランのID。

ResourceGroupId String 任意 rg-acfmxazb4ph****

リソースグループの ID です。

パラメーター名 String 任意 test123

EIP帯域幅プランの名前。

PageNumber Integer 任意 1

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

PageSize Integer 任意 10

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

DryRun Boolean 任意 false

リクエストのみを事前チェックするかどうかを指定します。 設定可能な値は以下のとおりです。

  • true: リクエストのみをチェックします。 リクエストが事前チェックに合格した後は、操作は実行されません。 チェック項目には、リクエスト形式、インスタンスのステータス、必要なパラメーターが指定されているかどうかが含まれます。 リクエストが事前チェックに合格しなかった場合、対応するエラーメッセージが返されます。 リクエストが事前チェックに合格した場合、DryRunOperationエラーコードが返されます。
  • false (デフォルト): APIリクエストを送信します。 リクエストが事前チェックに合格すると、2xx HTTPステータスコードが返され、操作が実行されます。
SecurityProtectionEnabled Boolean 任意 false

Anti-DDoS Pro/Premiumを有効にするかどうかを指定します。 設定可能な値は以下のとおりです。

  • false (デフォルト): Anti-DDoS Pro/Premiumを無効にします。
  • true: Anti-DDoS Pro/Premiumを有効にします。

レスポンスパラメーター

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

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

RequestId String 20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33

リクエストの ID です。

PageNumber Integer 1

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

TotalCount Integer 1

返されたエントリの数。

CommonBandwidthパッケージ CommonBandwidthPackageの配列

EIP帯域幅プランの詳細。

CommonBandwidthPackage
ReservationActiveTime String 2018-08-30T16:00:00Z

更新が有効になる時刻。 時刻はYYYY-MM-DDThh:mm:ssZ形式で表示されます。

ステータス String Available

EIP帯域幅プランのステータス。 デフォルト値: Available。

CreationTime String 2017-06-28T06:39:20Z

EIP帯域幅プランが作成された時刻。 時刻はYYYY-MM-DDThh:mm:ssZ形式に従います。

ReservationOrderType String RENEWCHANGE

更新方法。 設定可能な値は以下のとおりです。

  • RENEWCHANGE: アップグレードまたはダウングレードによる更新
  • TEMP_UPGRADE: 一時的なアップグレード
  • アップグレード: アップグレード
DeletionProtection Boolean true

削除保護が有効かどうかを示します。 設定可能な値は以下のとおりです。

  • true: 有効
  • false: 無効
ReservationInternetChargeType String 帯域幅課金

新しい課金方法。

比率 Integer 20

最小帯域幅コミットメントの割合。 20が返されます。

注 このパラメーターは、Alibaba Cloud Chinaサイトでのみ使用できます。
InstanceChargeType String PostPaid

EIP帯域幅プランの課金方法。

PostPaid (従量課金) が返されます。

RegionId String cn-hangzhou

EIP帯域幅プランのリージョンID。

BandwidthPackageId String cbwp-bp1t3sm1ffzmshdki****

EIP帯域幅プランのID。

ServiceManaged Integer 1

リソースがサービスアカウントによって作成されたかどうかを示します。 設定可能な値は以下のとおりです。

  • 0: なし
  • 1: はい
帯域幅 String 20

EIP帯域幅プランの最大帯域幅。 単位：Mbit/秒

説明 String none

EIP帯域幅プランの説明。

ExpiredTime String 2019-01-15T03:08:37Z

EIP帯域幅プランの有効期限が切れる時刻。 時刻はYYYY-MM-DDThh:mm:ssZ形式に従います。

ReservationBandwidth String 1000

新しい最大帯域幅。 単位：Mbit/秒

ResourceGroupId String rg-acfmxazb4ph****

リソースグループの ID です。

InternetChargeType String 帯域幅課金

EIP帯域幅プランの計測方法。 設定可能な値は以下のとおりです。

  • PayBy95: pay-by-enhanced-95th-percentile
  • PayByBandwidth: 帯域幅課金
BusinessStatus String 通常

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

  • Normal: EIP帯域幅プランは期待どおりに機能します。
  • FinancialLocked: EIP帯域幅プランに料金滞納があります。
  • Unactivated: EIP帯域幅プランが有効化されていません。
パラメーター名 String abc

EIP帯域幅プランの名前。

ISP String BGP

ラインタイプ。 設定可能な値は以下のとおりです。

  • BGP: BGP (マルチISP)
  • BGP_PRO: BGP (マルチISP) プロ
HasReservationData String false

保留中の注文が返されるかどうかを示します。 設定可能な値は以下のとおりです。

  • false: いいえ
  • true: はい
PublicIpAddresses PublicIpAddresseの配列

EIP帯域幅プランに関連付けられているelastic IPアドレス (EIP) 。

PublicIpAddresse
IpAddress String 47.95.XX.XX

パブリック IP アドレスを設定します。

AllocationId String eip-bp13e9i2qst4g6jzi****

EIP の ID 。

BandwidthPackageIpRelationStatus String BINDED

EIPがEIP帯域幅プランに関連付けられているかどうかを示します。 設定可能な値は以下のとおりです。

  • BINDED: 関連付けられている
  • BINDING: 関連付ける
SecurityProtectionTypes 文字列の配列 AntiDDoS_Enhanced

Anti-DDoSのエディション。 設定可能な値は以下のとおりです。

  • このパラメーターが空の場合、Anti-DDoS Originが有効になっていることを示します。
  • AntiDDoS_Enhancedが返された場合、Anti-DDoS Pro/Premiumが有効になっていることを示します。

例

リクエストの例

http(s)://[Endpoint]/?Action=DescribeCommonBandwidthPackages
&IncludeReservationData=false
&RegionId=cn-hangzhou
&BandwidthPackageId=cbwp-2ze2ic1xd2qeqk145 ****
&ResourceGroupId=rg-acfmxazb4ph ****
&名前=test123
&PageNumber=1
&PageSize=10
&DryRun=false
&SecurityProtectionEnabled=false
&共通リクエストパラメータ

正常に処理された場合のレスポンス例

XML 形式 

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

<DescribeCommonBandwidthPackagesResponse>
    <PageSize>10</PageSize>
    <RequestId>20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <CommonBandwidthPackages>
        <ReservationActiveTime>2018-08-30T16:00:00Z</ReservationActiveTime>
        <Status>Available</Status>
        <CreationTime>2017-06-28T06:39:20Z</CreationTime>
        <ReservationOrderType>RENEWCHANGE</ReservationOrderType>
        <DeletionProtection>true</DeletionProtection>
        <ReservationInternetChargeType>PayByBandwidth</ReservationInternetChargeType>
        <比率> 20</比率>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <RegionId>cn-hangzhou</RegionId>
        <BandwidthPackageId>cbwp-bp1t3sm1ffzmshdki ****</BandwidthPackageId>
        <ServiceManaged>1</ServiceManaged>
        <Bandwidth>20</Bandwidth>
        <説明> なし </説明>
        <ExpiredTime>2019-01-15T03:08:37Z</ExpiredTime>
        <ReservationBandwidth>1000</ReservationBandwidth>
        <ResourceGroupId>rg-acfmxazb4ph ****</ResourceGroupId>
        <InternetChargeType>PayByBandwidth</InternetChargeType>
        <BusinessStatus>Normal</BusinessStatus>
        <名前> abc</名前>
        <ISP>BGP</ISP>
        <HasReservationData>false</HasReservationData>
        <PublicIpAddresses>
            <IpAddress>47.95.XX.XX</IpAddress>
            <AllocationId>eip-bp13e9i2qst4g6jzi ****</AllocationId>
            <BandwidthPackageIpRelationStatus>BINDED</BandwidthPackageIpRelationStatus>
        </PublicIpAddresses>
        <SecurityProtectionTypes>AntiDDoS_Enhanced</SecurityProtectionTypes>
    </CommonBandwidthPackages>
</DescribeCommonBandwidthPackagesResponse>

JSON 形式 

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

{
  "PageSize" : 10,
  "RequestId" : "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33" 、
  "PageNumber" : 1,
  "TotalCount" : 1、
  "CommonBandwidthPackages" : [ {
    "ReservationActiveTime" : "2018-08-30T16:00:00Z" 、
    "ステータス" : "利用可能" 、
    "CreationTime" : "2017-06-28T06:39:20Z" 、
    "ReservationOrderType" : "RENEWCHANGE" 、
    "DeletionProtection" : true、
    "ReservationInternetChargeType" : "PayByBandwidth" 、
    「比率」: 20、
    "InstanceChargeType" : "PostPaid" 、
    "RegionId" : "cn-hangzhou" 、
    "BandwidthPackageId" : "cbwp-bp1t3sm1ffzmshdki ****" 、
    "ServiceManaged" : 1、
    "帯域幅" : "20" 、
    "Description" : "none" 、
    "ExpiredTime" : "2019-01-15T03:08:37Z" 、
    "ReservationBandwidth" : "1000" 、
    "ResourceGroupId" : "rg-acfmxazb4ph ****" 、
    "InternetChargeType" : "PayByBandwidth" 、
    "BusinessStatus" : "Normal" 、
    "Name" : "abc" 、
    "ISP" : "BGP" 、
    "HasReservationData" : "false" 、
    "PublicIpAddresses" : [ {
      "IpAddress" : "47.95.XX.XX" 、
      "AllocationId" : "eip-bp13e9i2qst4g6jzi ****" 、
      "BandwidthPackageIpRelationStatus" : "BINDED"
    } ],
    "SecurityProtectionTypes" : [ "AntiDDoS_Enhanced"]
  } ]
}

エラーコード

HttpCode エラーコード エラーメッセージ 説明
400 InvalidBandwidthPackageIdNumber.NotSupported BandwidthPackageIdsの数が制限を超えています。 EIP帯域幅プランの数が上限に達した場合に返されるエラーメッセージ。
400 InvalidResourceGroupId 指定されたResourceGroupIdは存在しません。 指定されたリソースグループIDが無効な場合に返されるエラーメッセージ。
400 OperationUnsupported.ResourceGroupId ResourceGroupはこのリージョンではサポートされていません。 リソースグループ機能が無効になっている場合に返されるエラーメッセージ。
404 InvalidRegionId.NotFound 指定された RegionIdはレコードに存在しません。 指定されたリージョンIDが存在しない場合に返されるエラーメッセージ。

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