DescribeCommonBandwidthPackages - Internet Shared Bandwidth - Alibaba Cloud ドキュメントセンター

リージョン内の Internet Shared Bandwidth インスタンスのリストをクエリします。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
IncludeReservationData	boolean	任意	保留中の注文に関する情報を返すかどうかを指定します。有効値： false (デフォルト) true	false
RegionId	string	必須	Internet Shared Bandwidth インスタンスが存在するリージョンの ID です。 DescribeRegions 操作を呼び出して、リージョン ID をクエリできます。	cn-hangzhou
BandwidthPackageId	string	任意	Internet Shared Bandwidth インスタンスの ID です。	cbwp-2ze2ic1xd2qeqk145****
ResourceGroupId	string	任意	リソースグループの ID です。	rg-acfmxazb4ph****
Name	string	任意	Internet Shared Bandwidth インスタンスの名前です。	test123
PageNumber	integer	任意	ページ番号です。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数です。有効値：1 ～ 50。デフォルト値：10。	10
DryRun	boolean	任意	実際のリクエストを実行せずにドライランを実施するかどうかを指定します。有効値： true：ドライランのみを実行します。システムは、パラメーター値の欠落、リクエスト構文の誤り、インスタンスステータスなど、潜在的な問題をチェックします。ドライランに失敗した場合は、エラーメッセージが返されます。ドライランに成功した場合は、`DryRunOperation` エラーコードが返されます。 false (デフォルト)：ドライランを実行し、実際のリクエストも実行します。ドライランに成功した場合は、2xx HTTP ステータスコードが返され、操作が実行されます。	false
Tag	array<object>	任意	Internet Shared Bandwidth インスタンスに追加するタグです。
	object	任意
Key	string	任意	Internet Shared Bandwidth インスタンスに追加するタグキーです。最大 20 個のタグキーを指定できます。タグキーは空文字列にできません。タグキーの長さは最大 128 文字です。`aliyun` または `acs:` で開始してはならず、`http://` または `https://` を含んではなりません。	KeyTest
Value	string	任意	Internet Shared Bandwidth インスタンスに追加するタグ値です。最大 20 個のタグ値を指定できます。タグ値は空文字列にできます。タグ値の長さは最大 128 文字です。`aliyun` または `acs:` で開始してはならず、`http://` または `https://` を含んではなりません。	ValueTest
SecurityProtectionEnabled	boolean	任意	Anti-DDoS Pro/Premium を有効にするかどうかを指定します。有効値： false (デフォルト) true	false

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターです。
PageSize	integer	1 ページあたりのエントリ数です。	10
RequestId	string	リクエスト ID です。	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33
PageNumber	integer	ページ番号です。	1
TotalCount	integer	返されたエントリの総数です。	1
CommonBandwidthPackages	object
CommonBandwidthPackage	array<object>	Internet Shared Bandwidth インスタンスの詳細です。
	array<object>
ReservationActiveTime	string	更新が有効になった時刻です。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で表示されます。	2018-08-30T16:00:00Z
Status	string	Internet Shared Bandwidth インスタンスのステータスです。有効値： Available：Internet Shared Bandwidth インスタンスは利用可能です。 Modifying：Internet Shared Bandwidth インスタンスは変更中です。	Available
CreationTime	string	Internet Shared Bandwidth インスタンスが作成された時刻です。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で表示されます。	2017-06-28T06:39:20Z
ReservationOrderType	string	更新方法です。有効値： RENEWCHANGE：スペック変更付きの更新 TEMP_UPGRADE：一時的なアップグレード付きの更新 UPGRADE：アップグレード付きの更新	RENEWCHANGE
DeletionProtection	boolean	削除保護が有効かどうかを示します。有効値： true false	true
ReservationInternetChargeType	string	構成変更後の課金方法です。有効値： PayByTraffic	PayByBandwidth
Ratio	integer	最低帯域幅の割合 (%) です。常に 20 が返されます。説明このパラメーターは、Alibaba Cloud 中国サイトでのみサポートされています。	20
InstanceChargeType	string	Internet Shared Bandwidth インスタンスの課金方法です。有効値： PostPaid：従量課金	PostPaid
RegionId	string	Internet Shared Bandwidth インスタンスが存在するリージョンの ID です。	cn-hangzhou
BandwidthPackageId	string	Internet Shared Bandwidth インスタンスの ID です。	cbwp-bp1t3sm1ffzmshdki****
ServiceManaged	integer	リソースがサービスアカウントによって作成されたかどうかを示します。有効値： 0：リソースはサービスアカウントによって作成されていません。 1：リソースはサービスアカウントによって作成されています。	1
Bandwidth	string	Internet Shared Bandwidth インスタンスの最大帯域幅です。単位：Mbit/s。	20
Description	string	Internet Shared Bandwidth インスタンスの説明です。	none
ExpiredTime	string	Internet Shared Bandwidth インスタンスの期限切れ時刻です。時刻は `YYYY-MM-DDThh:mm:ssZ` 形式で表示されます。	2019-01-15T03:08:37Z
ReservationBandwidth	string	構成変更後の新しい最大帯域幅です。単位：Mbit/s。	1000
ResourceGroupId	string	リソースグループの ID です。	rg-acfmxazb4ph****
InternetChargeType	string	Internet Shared Bandwidth インスタンスの課金方法です。有効値： PayByTraffic	PayByBandwidth
BusinessStatus	string	Internet Shared Bandwidth インスタンスのサービスステータスです。有効値： Normal：Internet Shared Bandwidth インスタンスは正常に動作しています。 FinancialLocked：Internet Shared Bandwidth インスタンスで支払い遅延が発生しています。 Unactivated：Internet Shared Bandwidth インスタンスはアクティベートされていません。	Normal
Name	string	Internet Shared Bandwidth インスタンスの名前です。	abc
ISP	string	回線タイプです。有効値： BGP：BGP(マルチ ISP) 回線。BGP(マルチ ISP) 回線はすべてのリージョンでサポートされています。 BGP_PRO：BGP (マルチ ISP) Pro 回線。BGP (マルチ ISP) Pro 回線は、中国 (香港)、シンガポール、日本 (東京)、フィリピン (マニラ)、マレーシア (クアラルンプール)、インドネシア (ジャカルタ)、タイ (バンコク) の各リージョンでサポートされています。シングル ISP 帯域幅の使用が許可されている場合、次のいずれかの値が返されます： ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 サービスが中国東部 1 Finance にデプロイされている場合、BGP_FinanceCloud が返されます。	BGP
HasReservationData	string	保留中の注文に関する情報が返されたかどうかを示します。有効値： false true	false
PublicIpAddresses	object
PublicIpAddresse	array<object>	Internet Shared Bandwidth インスタンスに関連付けられた EIP です。
	object
IpAddress	string	パブリック IP アドレスです。	47.95.XX.XX
AllocationId	string	EIP の ID です。	eip-bp13e9i2qst4g6jzi****
BandwidthPackageIpRelationStatus	string	EIP が Internet Shared Bandwidth インスタンスに関連付けられているかどうかを示します。有効値： BINDED BINDING	BINDED
SecurityProtectionTypes	object
SecurityProtectionType	array	Anti-DDoS のエディションです。このパラメーターが空の場合、Anti-DDoS Origin Basic が有効になります。 AntiDDoS_Enhanced が返された場合、Anti-DDoS Pro/Premium が有効になります。
	string	Anti-DDoS のエディションです。このパラメーターが空の場合、Anti-DDoS Origin Basic が有効になります。 AntiDDoS_Enhanced が返された場合、Anti-DDoS Pro/Premium が有効になります。	AntiDDoS_Enhanced
Tags	object
Tag	array<object>	Internet Shared Bandwidth インスタンスに追加されたタグです。
	object
Key	string	Internet Shared Bandwidth インスタンスに追加されたタグキーです。	KeyTest
Value	string	Internet Shared Bandwidth インスタンスに追加されたタグ値です。	ValueTest
BizType	string	Internet Shared Bandwidth インスタンスのサービスタイプです。有効値： CloudBox：クラウドボックス。クラウドボックスユーザーのみがこのタイプを選択できます。 Default (デフォルト)：汎用サービスタイプ。	CloudBox
Zone	string	Internet Shared Bandwidth インスタンスのゾーンです。このパラメーターは、BizType が CloudBox に設定されている場合にのみ返されます。BizType が Default に設定されている場合は、空の値が返されます。	ap-southeast-1-lzdvn-cb

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33",
  "PageNumber": 1,
  "TotalCount": 1,
  "CommonBandwidthPackages": {
    "CommonBandwidthPackage": [
      {
        "ReservationActiveTime": "2018-08-30T16:00:00Z",
        "Status": "Available",
        "CreationTime": "2017-06-28T06:39:20Z",
        "ReservationOrderType": "RENEWCHANGE",
        "DeletionProtection": true,
        "ReservationInternetChargeType": "PayByBandwidth",
        "Ratio": 20,
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "BandwidthPackageId": "cbwp-bp1t3sm1ffzmshdki****",
        "ServiceManaged": 1,
        "Bandwidth": "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": {
          "PublicIpAddresse": [
            {
              "IpAddress": "47.95.XX.XX",
              "AllocationId": "eip-bp13e9i2qst4g6jzi****",
              "BandwidthPackageIpRelationStatus": "BINDED"
            }
          ]
        },
        "SecurityProtectionTypes": {
          "SecurityProtectionType": [
            "AntiDDoS_Enhanced"
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "KeyTest",
              "Value": "ValueTest"
            }
          ]
        },
        "BizType": "CloudBox",
        "Zone": "ap-southeast-1-lzdvn-cb"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidBandwidthPackageIdNumber.NotSupported	The number of BandwidthPackageIds exceeds the limit.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

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

変更履歴

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