DescribeBandwidthPackages - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

DescribeBandwidthPackages

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:DescribeBandwidthPackages

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	帯域幅パッケージが属するリージョンの ID です。
BandwidthPackageId	string	任意	帯域幅パッケージの ID です。
NatGatewayId	string	任意	NAT ゲートウェイの ID です。このパラメータを指定すると、指定された NAT ゲートウェイに関連付けられている帯域幅パッケージのみを返します。
PageNumber	integer	任意	ページ番号です。開始値：1。デフォルト値：1。
PageSize	integer	任意	各ページに返されるエントリ数です。有効な値：1～100。デフォルト値：20。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスデータです。
PageSize	integer	ページあたりのエントリ数です。
RequestId	string	リクエスト ID です。
PageNumber	integer	ページ番号です。
TotalCount	integer	一致するエントリの総数です。
BandwidthPackages	object	照会された帯域幅パッケージの詳細です。
BandwidthPackage	array<object>	帯域幅パッケージの配列です。
	array<object>
Status	string	帯域幅パッケージのステータスです。有効な値： `Available`、`Pending`、`Modifying`、`Deleting`、`Deleted` です。
CreationTime	string	帯域幅パッケージが作成された時刻です。時刻は UTC で、 `YYYY-MM-DDThh:mm:ssZ` 形式です。
IpCount	string	帯域幅パッケージ内のパブリック IP アドレスの数です。
RegionId	string	帯域幅パッケージのリージョン ID です。
InstanceChargeType	string	帯域幅パッケージの課金方法です。有効な値： `PostPaid` (従量課金)、`PrePaid` (前払い) です。
BandwidthPackageId	string	帯域幅パッケージの ID です。
Description	string	帯域幅パッケージの説明です。
Bandwidth	string	帯域幅パッケージの帯域幅 (Mbit/s) です。
NatGatewayId	string	帯域幅パッケージを使用する NAT ゲートウェイの ID です。
ZoneId	string	帯域幅パッケージのゾーン ID です。
InternetChargeType	string	ネットワークの課金方法です。有効な値： `PayByTraffic` (トラフィック課金)、`PayByBandwidth` (帯域幅課金) です。
BusinessStatus	string	帯域幅パッケージのサービスステータスです。有効な値： `Normal` (正常)、`FinancialLocked` (支払い延滞によりロック済み) です。
Name	string	帯域幅パッケージの名前です。
ISP	string	回線タイプです。有効な値： `BGP`、`BGP_PRO` です。
PublicIpAddresses	object	帯域幅パッケージ内のパブリック IP アドレスです。
PublicIpAddresse	array<object>	パブリック IP アドレスの配列です。
	object
IpAddress	string	パブリック IP アドレスです。
AllocationId	string	パブリック IP アドレスに関連付けられた EIP のアロケーション ID です。

例

成功レスポンス

JSONJSON

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "BandwidthPackages": {
    "BandwidthPackage": [
      {
        "Status": "",
        "CreationTime": "",
        "IpCount": "",
        "RegionId": "",
        "InstanceChargeType": "",
        "BandwidthPackageId": "",
        "Description": "",
        "Bandwidth": "",
        "NatGatewayId": "",
        "ZoneId": "",
        "InternetChargeType": "",
        "BusinessStatus": "",
        "Name": "",
        "ISP": "",
        "PublicIpAddresses": {
          "PublicIpAddresse": [
            {
              "IpAddress": "",
              "AllocationId": ""
            }
          ]
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidAliuid	User Id is not valid.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。