DescribeCens - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeCens	The operation that you want to perform. Set the value to DescribeCens.
PageNumber	Integer	No	1	The number of the page to return. Default value: 1.
PageSize	Integer	No	10	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.
Filter.N.Key	String	No	CenId	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.
Filter.N.Value.N	String	No	cen-44m0p68spvlrqq****	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.
Tag.N.Key	String	No	tagtest	The tag keys of the resources. The tag keys cannot be an empty string. The tag keys cannot exceed 64 characters in length, and cannot start with `http://` or `https://`. You can specify at most 20 tag keys in each call.
Tag.N.Value	String	No	tagtest	The tag values of the resources. The tag values can be 0 to 128 characters in length, and cannot start with `http://` or `https://`. Each tag key has a unique tag value. You can specify at most 20 tag values in each call.

Response parameters


Parameter	Type	Example	Description
PageSize	Integer	10	The number of entries returned per page.
RequestId	String	2BFA6822-240E-4E27-B4C8-AA400EF7474D	The ID of the request.
PageNumber	Integer	1	The number of the page returned.
TotalCount	Integer	1	The total number of entries returned.
Cens	Array of Cen		The information about the CEN instance.
Cen
Status	String	Active	The status of the CEN instance. Creating: The CEN instance is being created. Active: The CEN instance is running. Deleting: The CEN instance is being deleted.
CreationTime	String	2019-10-22T07:44Z	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.
Ipv6Level	String	DISABLED	Indicates whether IPv6 is enabled for the CEN instance. ENABLE: enabled DISABLED: disabled
Description	String	desctest	The description of the CEN instance.
ResourceGroupId	String	rg-acfm3unpnuw****	The ID of the resource group to which the CEN instance belongs.
CenId	String	cen-0xyeagctz5sfg9****	The ID of the CEN instance.
ProtectionLevel	String	REDUCED	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.
Name	String	nametest	The name of the CEN instance.
Tags	Array of Tag		The IDs of the tags that are added to the CEN instance.
Tag
Key	String	tagtest	The tag key.
Value	String	tagtest	The tag value.
CenBandwidthPackageIds	Array of String	cenbwp-4c2zaavbvh5f42****	The IDs of the bandwidth plans that are associated with the CEN instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCens
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"CenId","Value":["cen-44m0p68spvlrqq****"]}]
&Tag=[{"Key":"tagtest","Value":"tagtest"}]
&<Common request parameters>

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCensResponse>
    <TotalCount>1</TotalCount>
    <RequestId>2BFA6822-240E-4E27-B4C8-AA400EF7474D</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Cens>
        <Cen>
            <Status>Active</Status>
            <ProtectionLevel>REDUCED</ProtectionLevel>
            <ResourceGroupId>rg-acfm3unpnuw****</ResourceGroupId>
            <Ipv6Level>DISABLED</Ipv6Level>
            <CenId>cen-0xyeagctz5sfg9****</CenId>
            <CreationTime>2019-10-22T07:44Z</CreationTime>
            <CenBandwidthPackageIds>
            </CenBandwidthPackageIds>
            <Name>nametest</Name>
        </Cen>
    </Cens>
</DescribeCensResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error code


HttpCode	Error code	Error message	Description
400	InvalidTagKey	The tag keys are not valid.	The error message returned because the tag key is invalid.

For a list of error codes, visit the API Error Center.