All Products
Search
Document Center

Cloud Enterprise Network:DescribeCens

Last Updated:Mar 01, 2024

Queries the information about your Cloud Enterprise Network (CEN) instances.

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:DescribeCensLIST
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

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

1
PageSizeintegerNo

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

10
ResourceGroupIdstringNo

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

rg-acfm3unpnuw****
Filterobject []No

The filter conditions.

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

KeystringNo

The key of the filter. 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
ValuearrayNo

The value of the filter condition.

Specify a filter value based on the Key parameter. 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.

stringNo

The value of the filter condition.

Specify a filter value based on the Key parameter. 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****
Tagobject []No

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.

tagtest
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://.

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

tagtest

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

2BFA6822-240E-4E27-B4C8-AA400EF7474D
PageNumberinteger

The number of the page returned.

1
TotalCountinteger

The total number of entries returned.

1
Censobject []

The information about the CEN instance.

Statusstring

The status of the CEN instance.

  • Creating
  • Active
  • Deleting
Active
CreationTimestring

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
Ipv6Levelstring

Indicates whether IPv6 is enabled for the CEN instance.

  • ENABLE
  • DISABLED
DISABLED
Descriptionstring

The description of the CEN instance.

desctest
ResourceGroupIdstring

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

rg-acfm3unpnuw****
CenIdstring

The CEN instance ID.

cen-0xyeagctz5sfg9****
ProtectionLevelstring

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
Namestring

The CEN instance name.

nametest
Tagsobject []

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

Keystring

The tag key.

tagtest
Valuestring

The tag value.

tagtest
CenBandwidthPackageIdsarray

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

string

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

cenbwp-4c2zaavbvh5f42****

Examples

Sample success responses

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 status codeError codeError messageDescription
400InvalidTagKeyThe tag keys are not valid.The error message returned because the specified tag key is invalid.
400InvalidTagValueThe tag values are not valid.The error message returned because the specified tag value 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 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