DescribeCenBandwidthPackages查詢頻寬包詳細資料-雲企業網-阿里雲 - Cloud Enterprise Network

呼叫 DescribeCenBandwidthPackages 介面查詢頻寬包執行個體的資訊。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:DescribeCenBandwidthPackages

get

*CenBandwidthPackage

acs:cen:*:{#accountId}:cenbandwidthpackage/*

無

請求參數

名稱	類型	必填	描述	樣本值
IncludeReservationData	boolean	否	是否包含續費資料，取值： true：包含續費資料。 false：不包含續費資料。	true
PageNumber	integer	否	列表的頁碼，預設值為 1。	1
PageSize	integer	否	分頁查詢時每頁的列數，最大值為 50，預設值為 10。	2
IsOrKey	boolean	否	篩選條件之間的關係，取值： false（預設）：篩選條件之間是與的關係。即必須符合所有篩選條件，才視為匹配篩選條件。 true：篩選條件之間是或的關係。即只要符合其中一個篩選條件，則視為匹配篩選條件。	false
ResourceGroupId	string	否	資源群組 ID。	rg-acfnwjeo4tv****
Filter	array<object>	否	篩選資訊。
	object	否	篩選資訊。
Key	string	否	篩選條件。您可以透過篩選條件篩選要檢視的頻寬包執行個體。系統支援以下篩選條件： CenId：雲企業網執行個體的 ID。 Status：頻寬包執行個體的狀態，取值： Idle：未綁定。 InUse：已綁定。 CenBandwidthPackageId：頻寬包的 ID。 Name：頻寬包的名稱。支援輸入一個或多個篩選條件，N 的最大值為 5。	CenId
Value	array	否	根據 Key 指定篩選值。一個 Key 支援指定多個篩選值，每個篩選值之間是或的關係，即只要符合其中一個篩選值，則視為匹配該篩選條件。	Idle
	string	否	根據 Key 指定篩選值。一個 Key 支援指定多個篩選值，每個篩選值之間是或的關係，即只要符合其中一個篩選值，則視為匹配該篩選條件。	cen-xxjsjfkffkfkfjkf****
Tag	array<object>	否	標籤資訊列表。一次最多支援輸入 20 個標籤資訊。
	object	否	標籤資訊。一次最多支援輸入 20 個標籤資訊。
Key	string	否	資源的標籤鍵。一旦傳入該值，則不允許為空字串。最多支援 64 個字元，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。一次最多支援輸入 20 個標籤的標籤鍵。	TagKey
Value	string	否	資源的標籤值。標籤值可以為空或輸入不超過 128 個字元的字串，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://` 。每一個標籤鍵對應一個標籤值，一次最多支援輸入 20 個標籤鍵對應的標籤值。	TagValue

返回參數

名稱	類型	描述	樣本值
	object
PageSize	integer	每頁包含的項目數。	2
RequestId	string	請求 ID。	9D7E2400-2755-4AF5-9B73-12565E4F73A0
PageNumber	integer	目前頁碼。	1
TotalCount	integer	列表項目數。	2
CenBandwidthPackages	object
CenBandwidthPackage	array<object>	頻寬包的詳細資訊。
	array<object>
ReservationActiveTime	string	臨時升級配置到期時間，採用 ISO 8601 格式表示，格式為：YYYY-MM-DDThh:mmZ。	2021-08-30T16:00Z
Status	string	頻寬包是否已綁定雲企業網執行個體。 Idle：未綁定。 InUse：已綁定。	InUse
CreationTime	string	頻寬包的建立時間，採用 ISO8601 格式表示，格式為：YYYY-MM-DDThh:mmZ。	2021-02-01T11:14Z
ReservationOrderType	string	續費變更配置方式。 TEMP_UPGRADE：短時升級配置。 UPGRADE：升級配置。	UPGRADE
BandwidthPackageChargeType	string	頻寬包的計費方式。	PREPAY
CenBandwidthPackageId	string	頻寬包的 ID。	cenbwp-4c2zaavbvh5x****
ReservationInternetChargeType	string	變更配置之後的計費方式。	PREPAY
GeographicRegionAId	string	要查詢的區域 ID。取值： china：中國內地。 asia-pacific：亞太。 europe：歐洲。 north-america：北美。	china
Bandwidth	integer	頻寬包的峰值頻寬。	2
Description	string	頻寬包描述。	cen
ExpiredTime	string	頻寬包逾時時間，採用 ISO 8601 格式表示，格式為：YYYY-MM-DDThh:mmZ。	2021-09-08T16:00Z
ReservationBandwidth	string	臨時升級配置結束後恢復的頻寬。	10
GeographicSpanId	string	區域對應的 ID。	north-america_china
GeographicRegionBId	string	頻寬包執行個體的另一個互連區域 ID。取值： china：中國內地。 asia-pacific：亞太。 europe：歐洲。 north-america：北美。	north-america
ResourceGroupId	string	資源群組 ID。	rg-aekzoyr5k36****
IsCrossBorder	boolean	是否是跨境頻寬包。 false：不是跨境頻寬包。 true：是跨境頻寬包。	false
BusinessStatus	string	頻寬包的狀態。 Normal：正常。 FinancialLocked：欠費鎖定。 SecurityLocked：安全風控鎖定。	Normal
Name	string	頻寬包的名稱。	test
HasReservationData	string	是否有續費資料。 true：有續費資料。 false：沒有續費資料。說明僅入參 IncludeReservationData 取值為 true，且有未生效訂購資料時才會為 true。	false
OrginInterRegionBandwidthLimits	object
OrginInterRegionBandwidthLimit	array<object>	互連地域的詳細資訊。
	object
BandwidthLimit	string	互連地域間的頻寬峰值。	1
OppositeRegionId	string	對端地域 ID。	us-west-1
GeographicSpanId	string	互連地域。	north-america_china
LocalRegionId	string	本端地域 ID。	cn-hangzhou
Tags	object
Tag	array<object>	頻寬包的標籤資訊。
	object	標籤列表。
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue
CenIds	object
CenId	array	頻寬包對應的雲企業網執行個體列表。
	string	頻寬包對應的雲企業網執行個體 ID。	cen-xxjsjfkffkfkfjkf****

樣本

正常返回樣本

JSON格式

{
  "PageSize": 2,
  "RequestId": "9D7E2400-2755-4AF5-9B73-12565E4F73A0",
  "PageNumber": 1,
  "TotalCount": 2,
  "CenBandwidthPackages": {
    "CenBandwidthPackage": [
      {
        "ReservationActiveTime": "2021-08-30T16:00Z",
        "Status": "InUse",
        "CreationTime": "2021-02-01T11:14Z",
        "ReservationOrderType": "UPGRADE",
        "BandwidthPackageChargeType": "PREPAY",
        "CenBandwidthPackageId": "cenbwp-4c2zaavbvh5x****",
        "ReservationInternetChargeType": "PREPAY",
        "GeographicRegionAId": "china",
        "Bandwidth": 2,
        "Description": "cen",
        "ExpiredTime": "2021-09-08T16:00Z",
        "ReservationBandwidth": "10",
        "GeographicSpanId": "north-america_china",
        "GeographicRegionBId": "north-america",
        "ResourceGroupId": "rg-aekzoyr5k36****",
        "IsCrossBorder": false,
        "BusinessStatus": "Normal",
        "Name": "test",
        "HasReservationData": "false",
        "OrginInterRegionBandwidthLimits": {
          "OrginInterRegionBandwidthLimit": [
            {
              "BandwidthLimit": "1",
              "OppositeRegionId": "us-west-1",
              "GeographicSpanId": "north-america_china",
              "LocalRegionId": "cn-hangzhou"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "CenIds": {
          "CenId": [
            "cen-xxjsjfkffkfkfjkf****"
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.TagValue	The tag values are not valid.	參數中指定的 tag value 不合法。
400	IllegalParam.TagKey	The tag keys are not valid.	參數中指定的 tag key 不合法。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無權限操作。

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

變更歷史

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