Query bandwidth plans using DescribeCenBandwidthPackages - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries information about bandwidth package instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DescribeCenBandwidthPackages

get

*CenBandwidthPackage

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

None

Request parameters

Parameter	Type	Required	Description	Example
IncludeReservationData	boolean	No	Specifies whether to include renewal data. Valid values: true: Includes renewal data. false: Does not include renewal data.	true
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	2
IsOrKey	boolean	No	The relationship between filter conditions. Valid values: false (default): The filter conditions have an AND relationship. A bandwidth package must meet all filter conditions to be considered a match. true: The filter conditions have an OR relationship. A bandwidth package that meets any one of the filter conditions is considered a match.	false
ResourceGroupId	string	No	The resource group ID.	rg-acfnwjeo4tv****
Filter	array<object>	No	The filter information.
	object	No	The filter information.
Key	string	No	The filter condition. You can use filter conditions to filter the bandwidth package instances you want to view. The following filter conditions are supported: CenId: The ID of the Cloud Enterprise Network (CEN) instance. Status: The status of the bandwidth package instance. Valid values: Idle: Not associated. InUse: Associated. CenBandwidthPackageId: The ID of the bandwidth package. Name: The name of the bandwidth package. You can specify one or more filter conditions. The maximum value of N is 5.	CenId
Value	array	No	The filter values based on the specified Key. You can specify multiple filter values for a single Key. The filter values have an OR relationship, which means that a bandwidth package matching any one of the filter values is considered a match for the filter condition.	Idle
	string	No	The filter values based on the specified Key. You can specify multiple filter values for a single Key. The filter values have an OR relationship, which means that a bandwidth package matching any one of the filter values is considered a match for the filter condition.	cen-xxjsjfkffkfkfjkf****
Tag	array<object>	No	The tag information list. You can specify up to 20 tags at a time.
	object	No	The tag information. You can specify up to 20 tags at a time.
Key	string	No	The tag key of the resource. Once specified, the tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys at a time.	TagKey
Value	string	No	The tag value of the resource. The tag value can be empty or a string of up to 128 characters. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. Each tag key corresponds to one tag value. You can specify up to 20 tag values at a time.	TagValue

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	2
RequestId	string	The request ID.	9D7E2400-2755-4AF5-9B73-12565E4F73A0
PageNumber	integer	The current page number.	1
TotalCount	integer	The total number of entries.	2
CenBandwidthPackages	object
CenBandwidthPackage	array<object>	The details of the bandwidth package.
	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 Note 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****

Examples

Success response

JSON format

{
  "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****"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.TagValue	The tag values are not valid.	The error message returned because the specified tag value is invalid.
400	IllegalParam.TagKey	The tag keys are not valid.	The error message returned because the specified tag key is invalid.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.