All Products
Search
Document Center

Cloud Enterprise Network:DescribeCens

Last Updated:Jan 11, 2023

Queries detailed information about Cloud Enterprise Network (CEN) instances within the current Alibaba Cloud account.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
cen:DescribeCens LIST
  • CEN
    acs:cen:*:{#accountId}:ceninstance/*
    without
without

Request parameters

Parameter Type Required Description Example
PageNumber integer No

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

1
PageSize integer No

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

10
Filter array No

The list of the filter conditions.

object No
Key string No

The filter condition. Valid values:

  • CenId: the ID of a CEN instance.
  • Name: the name of a CEN instance.

By default, the logical operator among filter conditions is AND. Information about a CEN instance is returned only if the CEN instance matches all filter conditions.

You can specify at most five filter conditions in each call.

CenId
Value array No

The values of the filter condition.

string No

The value of the filter condition.

This parameter sets the value of a filter key. You can specify multiple values for a filter key. The logical operator among multiple filter values is OR. If a CEN instance matches one or more of the values that you specify, the CEN instance matches the filter condition.

You can specify at most five values in each filter condition.

cen-44m0p68spvlrqq****
Tag array No

The tags.

object No
Key string No

The tag keys of the resources.

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.

tagtest
Value string No

The tag values of the resources.

The tag values can be 0 to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

Each tag key has a unique tag value. You can specify at most 20 tag values in each call.

tagtest

Response parameters

Parameter Type Description Example
object
PageSize integer

The number of entries returned per page.

10
RequestId string

The ID of the request.

2BFA6822-240E-4E27-B4C8-AA400EF7474D
PageNumber integer

The number of the page returned.

1
TotalCount integer

The total number of entries returned.

1
Cens array

The information about the CEN instance.

object
Status string

The status of the CEN instance.

  • Creating: The CEN instance is being created.
  • Active: The CEN instance is running.
  • Deleting: The instance is being deleted.
Active
CreationTime string

The time when the CEN instance was created.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

2019-10-22T07:44Z
Ipv6Level string

Indicates whether IPv6 is enabled for the CEN instance.

  • ENABLE: enabled
  • DISABLED: disabled
DISABLED
Description string

The description of the CEN instance.

desctest
ResourceGroupId string

The ID of the resource group to which the CEN instance belongs.

rg-acfm3unpnuw****
CenId string

The ID of the CEN instance.

cen-0xyeagctz5sfg9****
ProtectionLevel string

The level of CIDR block overlapping.

REDUCED: Overlapped CIDR blocks are allowed. This value specifies that CIDR blocks can overlap but CIDR blocks cannot be duplicates.

REDUCED
Name string

The name of the CEN instance.

nametest
Tags array

The IDs of the tags that are added to the CEN instance.

object
Key string

The key of the tag.

tagtest
Value string

The value of the tag.

tagtest
CenBandwidthPackageIds array

The IDs of the bandwidth plans that are associated with the CEN instance.

string

The ID of the bandwidth plan.

cenbwp-4c2zaavbvh5f42****

Example

Normal return example

JSONFormat

{
  "PageSize": 10,
  "RequestId": "2BFA6822-240E-4E27-B4C8-AA400EF7474D",
  "PageNumber": 1,
  "TotalCount": 1,
  "Cens": {
    "Cen": [
      {
        "Status": "Active",
        "CreationTime": "2019-10-22T07:44Z",
        "Ipv6Level": "DISABLED",
        "Description": "desctest",
        "ResourceGroupId": "rg-acfm3unpnuw****",
        "CenId": "cen-0xyeagctz5sfg9****",
        "ProtectionLevel": "REDUCED",
        "Name": "nametest",
        "Tags": {
          "Tag": [
            {
              "Key": "tagtest",
              "Value": "tagtest"
            }
          ]
        },
        "CenBandwidthPackageIds": {
          "CenBandwidthPackageId": [
            "cenbwp-4c2zaavbvh5f42****"
          ]
        }
      }
    ]
  }
}

Error codes

Http code Error code Error message
400 InvalidTagKey The tag keys are not valid.
400 InvalidTagValue The tag values are not valid.

For a list of error codes, visit the API error center.