调用DescribeCens接口查询当前阿里云账号下的云企业网实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCens

系统规定参数。取值:DescribeCens

PageNumber Integer 1

待查询的页码。默认值:1

PageSize Integer 10

分页查询时每页显示的条目数。取值范围:1~50。默认值:10

Filter.N.Key String CenId

过滤条件。取值:

  • CenId:云企业网实例ID。
  • Name:云企业网实例名称。

多个过滤条件之间默认是的关系,即必须符合所有过滤条件,才视为匹配过滤条件。

一次最多支持输入5个过滤条件。

Filter.N.Value.N String cen-44m0p68spvlrqq****

过滤条件的值。

根据Key指定过滤值。一个Key支持指定多个过滤值,多个过滤值之间是的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。

一个过滤条件最多支持输入5个过滤值。

Tag.N.Key String tagtest

资源的标签键。

一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以aliyun或者acs:开头,不能包含http://或者https://

一次最多支持输入20个标签的标签键。

Tag.N.Value String tagtest

资源的标签值。

标签值可以为空或输入不超过128个字符的字符串,不能以aliyun或者acs:开头,不能包含http://或者https://

每一个标签键对应一个标签值,一次最多支持输入20个标签键对应的标签值。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

分页查询时每页显示的条目数。

RequestId String 2BFA6822-240E-4E27-B4C8-AA400EF7474D

请求ID。

PageNumber Integer 1

查询的页码。

TotalCount Integer 1

总条目数。

Cens Array of Cen

云企业网实例信息列表。

Cen
Status String Active

云企业网实例的状态。

  • Creating:创建中。
  • Active:运行中。
  • Deleting:删除中。
CreationTime String 2019-10-22T07:44Z

云企业网实例的创建时间。

时间按照ISO8601标准表示,并使用UTC时间。格式为:YYYY-MM-DDThh:mmZ

Ipv6Level String DISABLED

云企业网实例是否已开启IPv6功能。

  • ENABLE:已开启。
  • DISABLED:未开启。
Description String desctest

云企业网实例的描述信息。

ResourceGroupId String rg-acfm3unpnuw****

云企业网实例所属的资源组ID。

CenId String cen-0xyeagctz5sfg9****

云企业网实例的ID。

ProtectionLevel String REDUCED

网段重叠的级别。

REDUCED:表示网段可以有重叠,但是不能完全相同。

Name String nametest

云企业网实例的名称。

Tags Array of Tag

云企业网实例绑定的标签列表。

Tag
Key String tagtest

标签键。

Value String tagtest

标签值。

CenBandwidthPackageIds Array of String cenbwp-4c2zaavbvh5f42****

云企业网实例绑定的带宽包的列表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeCens
&PageNumber=1
&PageSize=10
&Filter=[{"Key":"CenId","Value":["cen-44m0p68spvlrqq****"]}]
&Tag=[{"Key":"tagtest","Value":"tagtest"}]
&公共请求参数

正常返回示例

XML格式

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格式

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidTagKey The tag keys are not valid. 标签的Key值不合法。

访问错误中心查看更多错误码。