DescribeCommonBandwidthPackages - 查詢指定地區中共用頻寬執行個體列表 - Internet Shared Bandwidth

調用DescribeCommonBandwidthPackages介面查詢指定地區中共用頻寬執行個體列表及其資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
IncludeReservationData	boolean	否	是否包含未生效的訂購資料。取值： false（預設值）：不包含。 true：包含。	false
RegionId	string	是	共用頻寬所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou
BandwidthPackageId	string	否	共用頻寬執行個體的 ID。	cbwp-2ze2ic1xd2qeqk145****
ResourceGroupId	string	否	資源群組 ID。	rg-acfmxazb4ph****
Name	string	否	共用頻寬執行個體名稱。長度為 0-128 個字元，不能以`http://`或`https://`開頭。	test123
PageNumber	integer	否	列表的頁碼。預設值：1。	1
PageSize	integer	否	分頁查詢時每頁的行數。最大值：50。預設值：10。	10
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會查詢執行個體資訊。檢查項包括是否填寫了必需參數、請求格式、執行個體狀態。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。	false
Tag	array<object>	否	共用頻寬執行個體的標籤列表。
	object	否	共用頻寬執行個體的標籤列表。
Key	string	否	資源的標籤鍵。最多支援輸入 20 個標籤鍵。如需傳入該值，則不能輸入Null 字元串。一個標籤鍵最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	KeyTest
Value	string	否	資源的標籤值。最多支援輸入 20 個標籤值。如需傳入該值，可以輸入Null 字元串。最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	ValueTest
SecurityProtectionEnabled	boolean	否	是否開啟 DDoS 防護（增強版）。取值： false：不開啟。 true：開啟。說明該參數已廢棄。	false

返回參數

名稱	類型	描述	樣本值
	object	返回參數列表。
PageSize	integer	分頁查詢時每頁的行數。	10
RequestId	string	請求 ID。	20E6FD1C-7321-4DAD-BDFD-EC8769E4AA33
PageNumber	integer	列表的頁碼。	1
TotalCount	integer	列表條目數。	1
CommonBandwidthPackages	object
CommonBandwidthPackage	array<object>	共用頻寬的詳細資料。
	array<object>	共用頻寬的詳細資料。
ReservationActiveTime	string	續約生效時間，格式為`YYYY-MM-DDThh:mm:ssZ`。	2018-08-30T16:00:00Z
Status	string	共用頻寬執行個體的狀態。 Available：可用。 Modifying：修改中。	Available
CreationTime	string	共用頻寬執行個體建立的時間，格式為`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。說明僅中國站支援該參數。	20
InstanceChargeType	string	共用頻寬執行個體的計費類型。 PostPaid：隨用隨付。	PostPaid
RegionId	string	共用頻寬執行個體所在的地區 ID。	cn-hangzhou
BandwidthPackageId	string	共用頻寬的 ID。	cbwp-bp1t3sm1ffzmshdki****
ServiceManaged	integer	是否為服務帳號建立的資源。 0：非服務帳號建立。 1：服務帳號建立。	1
Bandwidth	string	共用頻寬的頻寬峰值，單位：Mbps。	20
Description	string	共用頻寬的描述資訊。	none
ExpiredTime	string	共用頻寬執行個體的到期時間，格式為`YYYY-MM-DDThh:mm:ssZ`。	2019-01-15T03:08:37Z
ReservationBandwidth	string	變更配置之後的頻寬值，單位：Mbps。	1000
ResourceGroupId	string	資源群組 ID。	rg-acfmxazb4ph****
InternetChargeType	string	共用頻寬的計費方式。 PayByBandwidth：按頻寬計費。 PayByDominantTraffic：按主流量計費。 PayByTraffic：按流量計費。	PayByBandwidth
BusinessStatus	string	共用頻寬執行個體的業務狀態。 Normal：正常狀態。 FinancialLocked：欠費。 Unactivated：未啟用。	Normal
Name	string	共用頻寬的名稱。	abc
ISP	string	線路類型。 BGP：BGP（多線）線路。目前全部地區都支援 BGP（多線）線路。 BGP_PRO：BGP（多線）_精品線路。目前僅中國香港、新加坡、日本（東京）、菲律賓（馬尼拉）、馬來西亞（吉隆坡）、印尼（雅加達）和泰國（曼穀）地區支援 BGP（多線）_精品線路共用頻寬。如果您是單線頻寬的白名單使用者，傳回型別還可能為： ChinaTelecom：中國電信 ChinaUnicom：中國聯通 ChinaMobile：中國移動 ChinaTelecom_L2：中國電信 L2 ChinaUnicom_L2：中國聯通 L2 ChinaMobile_L2：中國移動 L2 如果您是杭州金融雲使用者，返回BGP_FinanceCloud。	BGP
HasReservationData	string	是否有待生效的訂單。 false：沒有待生效的訂單。 true：有待生效的訂單。	false
PublicIpAddresses	object
PublicIpAddresse	array<object>	共用頻寬執行個體中的公網 IP 位址。
	object	共用頻寬執行個體中的公網 IP 位址。
IpAddress	string	公網 IP 位址。	47.95.XX.XX
AllocationId	string	公網 IP 的執行個體 ID。	eip-bp13e9i2qst4g6jzi****
BandwidthPackageIpRelationStatus	string	共用頻寬和 EIP 的關聯狀態。 BINDED：EIP 與共用頻寬關聯完成。 BINDING：關聯中。	BINDED
SecurityProtectionTypes	object
SecurityProtectionType	array	安全防護層級。返回為空白時，表示預設的 DDoS 防護（基礎版）。返回AntiDDoS_Enhanced時，表示 DDoS 防護（增強版）。說明該參數已廢棄。
	string	安全防護層級。返回為空白時，表示預設的 DDoS 防護（基礎版）。返回AntiDDoS_Enhanced時，表示 DDoS 防護（增強版）。說明該參數已廢棄。	AntiDDoS_Enhanced
Tags	object
Tag	array<object>	共用頻寬執行個體的標籤列表。
	object	共用頻寬執行個體的標籤列表。
Key	string	共用頻寬執行個體的標籤鍵。	KeyTest
Value	string	共用頻寬執行個體的標籤值。	ValueTest
BizType	string	共用頻寬的業務類型。 CloudBox：雲盒。僅雲盒使用者支援該類型。 Default（預設值）：預設，表示非特殊類型。	CloudBox
Zone	string	共用頻寬的可用性區域。當可用性區域資源過載時，為保證服務穩定性，共用頻寬可能會被調度至其他可用性區域。	ap-southeast-1-lzdvn-cb

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
400	InvalidBandwidthPackageIdNumber.NotSupported	The number of BandwidthPackageIds exceeds the limit.	共用頻寬包的數量超過Quota限制。
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	資源群組ID不存在。
400	OperationUnsupported.ResourceGroupId	ResourceGroup is not supported in this region.	資源群組功能未開啟。
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。