All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenBandwidthPackages

Last Updated:Mar 01, 2024

Queries the information about bandwidth plans.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cen:DescribeCenBandwidthPackagesLIST
  • CenBandwidthPackage
    acs:cen:*:{#accountId}:cenbandwidthpackage/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IncludeReservationDatabooleanNo

Specifies whether to include renewal data. Valid values:

  • true
  • false
true
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 50. Default value: 10.

2
IsOrKeybooleanNo

The logical operator between the filter conditions. Valid values:

  • false (default): AND Bandwidth plans that meet all filter conditions are returned.
  • true: OR Bandwidth plans that meet one of the filter conditions are returned.
false
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfnwjeo4tv****
Filterobject []No

The filter configurations.

KeystringNo

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
ValuearrayNo

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.

stringNo

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****
Tagobject []No

The information about the tags.

You can specify at most 20 tags in each call.

KeystringNo

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
ValuestringNo

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

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

2
RequestIdstring

The request ID.

9D7E2400-2755-4AF5-9B73-12565E4F73A0
PageNumberinteger

The number of the returned page.

1
TotalCountinteger

The total number of entries returned.

2
CenBandwidthPackagesobject []

The details about the bandwidth plan.

ReservationActiveTimestring

The expiration time of the temporary upgrade.

2021-08-30T16:00Z
Statusstring

Indicates whether the bandwidth plan is associated with a CEN instance.

  • Idle
  • InUse
InUse
CreationTimestring

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
ReservationOrderTypestring

The renewal method.

  • TEMP_UPGRADE: temporary upgrade
  • UPGRADE: upgrade
UPGRADE
BandwidthPackageChargeTypestring

The billing method of the bandwidth plan.

PREPAY
CenBandwidthPackageIdstring

The ID of the bandwidth plan.

cenbwp-4c2zaavbvh5x****
ReservationInternetChargeTypestring

The new billing method.

PREPAY
GeographicRegionAIdstring

The ID of the area that you want to query. Valid values:

  • china: Chinese mainland.
  • asia-pacific: Asia Pacific
  • europe: Europe
  • australia: Australia
  • north-america: North America
china
Bandwidthlong

The maximum bandwidth of the bandwidth plan.

2
Descriptionstring

The description of the bandwidth plan.

cen
ExpiredTimestring

The time when the bandwidth plan expires.

2021-09-08T16:00Z
ReservationBandwidthstring

The bandwidth value to which the bandwidth plan is restored when the temporary upgrade ends.

10
GeographicSpanIdstring

The ID of the connected area.

north-america_china
GeographicRegionBIdstring

The ID of the other area connected by the bandwidth plan. Valid values:

  • china: Chinese mainland.
  • asia-pacific: Asia Pacific
  • europe: Europe
  • australia: Australia
  • north-america: North America
north-america
ResourceGroupIdstring

The ID of the resource group to which the ACL belongs.

rg-aekzoyr5k36****
IsCrossBorderboolean

Indicates whether the bandwidth plan supports cross-border communication.

  • false
  • true
false
BusinessStatusstring

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
Namestring

The name of the bandwidth plan.

test
HasReservationDatastring

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
OrginInterRegionBandwidthLimitsobject []

The details about the connected regions.

BandwidthLimitstring

The maximum bandwidth value for the inter-region connection.

1
OppositeRegionIdstring

The ID of the peer region.

us-west-1
GeographicSpanIdstring

The connected regions.

north-america_china
LocalRegionIdstring

The ID of the local region.

cn-hangzhou
Tagsobject []

The tags of the bandwidth plan.

Keystring

The tag key.

TagKey
Valuestring

The tag value.

TagValue
CenIdsarray

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

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400IllegalParam.TagValueThe tag values are not valid.The error message returned because the specified tag value is invalid.
400IllegalParam.TagKeyThe tag keys are not valid.The error message returned because the specified tag key is invalid.
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-08The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
    Added Input Parameters: Tag
Output ParametersThe response structure of the API has changed.