DescribeCenBandwidthPackages - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

帯域幅プランの情報を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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 (デフォルト): AND すべてのフィルター条件を満たす帯域幅プランが返されます。 true: OR いずれかのフィルター条件を満たす帯域幅プランが返されます。	false
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfnwjeo4tv****
Filter	array<object>	任意	フィルター設定。
	object	任意
Key	string	任意	The filter conditions. You can use filter conditions to filter the bandwidth plans that you want to query. The following filter conditions are supported: CenId: CEN instance ID Status: bandwidth plan status. Valid values: Idle: not associated with a CEN instance. InUse: associated with a CEN instance. CenBandwidthPackageId: bandwidth plan ID Name: bandwidth plan name You can specify one or more filter conditions. The maximum value of N is 5.	CenId
Value	array	任意	Specify a filter value based on the Key parameter. You can specify multiple filter values for each Key. The logical operator between filter values is OR. If one filter value is matched, the filter condition is matched.	Idle
	string	任意	Specify a filter value based on the Key parameter. You can specify multiple filter values for each Key. The logical operator between filter values is OR. If a bandwidth plan matches one of the filter values, the bandwidth plan is a match.	cen-xxjsjfkffkfkfjkf****
Tag	array<object>	任意	タグの情報。各呼び出しで最大 20 個のタグを指定できます。
	object	任意
Key	string	任意	The tag keys. The tag keys cannot be an empty string. The tag keys can be up to 64 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`. You can specify at most 20 tag keys.	TagKey
Value	string	任意	The tag values. The tag values can be 0 to 128 characters in length, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. The tag value of each tag key must be unique. You can specify at most 20 tag values in each call.	TagValue

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	The number of entries returned per page.	2
RequestId	string	The request ID.	9D7E2400-2755-4AF5-9B73-12565E4F73A0
PageNumber	integer	The number of the returned page.	1
TotalCount	integer	The total number of entries returned.	2
CenBandwidthPackages	object
CenBandwidthPackage	array<object>	The details about the bandwidth plan.
	array<object>
ReservationActiveTime	string	The expiration time of the temporary upgrade.	2021-08-30T16:00Z
Status	string	Indicates whether the bandwidth plan is associated with a CEN instance. Idle InUse	InUse
CreationTime	string	The time when the bandwidth plan was created. The time is displayed in the ISO8601 standard in the YYYY-MM-DDThh:mmZ format.	2021-02-01T11:14Z
ReservationOrderType	string	The renewal method. TEMP_UPGRADE: temporary upgrade UPGRADE: upgrade	UPGRADE
BandwidthPackageChargeType	string	The billing method of the bandwidth plan.	PREPAY
CenBandwidthPackageId	string	The ID of the bandwidth plan.	cenbwp-4c2zaavbvh5x****
ReservationInternetChargeType	string	The new billing method.	PREPAY
GeographicRegionAId	string	The ID of the area that you want to query. Valid values: china: Chinese mainland. asia-pacific: Asia Pacific europe: Europe north-america: North America	china
Bandwidth	integer	The maximum bandwidth of the bandwidth plan.	2
Description	string	The description of the bandwidth plan.	cen
ExpiredTime	string	The time when the bandwidth plan expires.	2021-09-08T16:00Z
ReservationBandwidth	string	The bandwidth value to which the bandwidth plan is restored when the temporary upgrade ends.	10
GeographicSpanId	string	The ID of the connected area.	north-america_china
GeographicRegionBId	string	The ID of the other area connected by the bandwidth plan. Valid values: china: Chinese mainland. asia-pacific: Asia Pacific europe: Europe north-america: North America	north-america
ResourceGroupId	string	The ID of the resource group to which the ACL belongs.	rg-aekzoyr5k36****
IsCrossBorder	boolean	Indicates whether the bandwidth plan supports cross-border communication. false true	false
BusinessStatus	string	The status of the bandwidth plan. Valid values: Normal: running as expected. FinancialLocked: locked due to overdue payments. SecurityLocked: locked due to security reasons	Normal
Name	string	The name of the bandwidth plan.	test
HasReservationData	string	Indicates whether renewal data is included. true false 説明 This parameter returns true only when the IncludeReservationData parameter is set to true and a pending order exists.	false
OrginInterRegionBandwidthLimits	object
OrginInterRegionBandwidthLimit	array<object>	The details about the connected regions.
	object
BandwidthLimit	string	The maximum bandwidth value for the inter-region connection.	1
OppositeRegionId	string	The ID of the peer region.	us-west-1
GeographicSpanId	string	The connected regions.	north-america_china
LocalRegionId	string	The ID of the local region.	cn-hangzhou
Tags	object
Tag	array<object>	The tags of the bandwidth plan.
	object
Key	string	The tag key.	TagKey
Value	string	The tag value.	TagValue
CenIds	object
CenId	array	A list of CEN instances that are associated with the bandwidth plan.
	string	The ID of the CEN instance that is associated with the bandwidth plan.	cen-xxjsjfkffkfkfjkf****

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ
400	IllegalParam.TagValue	The tag values are not valid.
400	IllegalParam.TagKey	The tag keys are not valid.
400	InvalidParameter	Invalid parameter.
400	Unauthorized	The AccessKeyId is unauthorized.

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

変更履歴

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