全部产品
Search
文档中心

云企业网:DescribeCens - 查看账户下所有云企业网实例的详细信息

更新时间:Mar 01, 2024

调用DescribeCens接口查询当前阿里云账号下的云企业网实例的状态、是否已开启IPv6功能、实例绑定的带宽包的列表等信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:DescribeCensLIST
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/*

请求参数

名称类型必填描述示例值
PageNumberinteger

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

1
PageSizeinteger

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

10
ResourceGroupIdstring

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

rg-acfm3unpnuw****
Filterobject []

过滤条件的信息。

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

Keystring

过滤条件。取值:

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

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

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

CenId
Valuearray

过滤条件的值。

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

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

string

过滤条件的值。

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

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

cen-44m0p68spvlrqq****
Tagobject []

标签信息。

一次最多支持输入 20 个标签信息。

Keystring

资源的标签键。

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

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

tagtest
Valuestring

资源的标签值。

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

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

tagtest

返回参数

名称类型描述示例值
object

返回结果。

PageSizeinteger

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

10
RequestIdstring

请求 ID。

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

查询的页码。

1
TotalCountinteger

总条目数。

1
Censobject []

云企业网实例信息列表。

Statusstring

云企业网实例的状态。

  • Creating:创建中。

  • Active:运行中。

  • Deleting:删除中。

Active
CreationTimestring

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

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

2019-10-22T07:44Z
Ipv6Levelstring

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

  • ENABLE:已开启。
  • DISABLED:未开启。
DISABLED
Descriptionstring

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

desctest
ResourceGroupIdstring

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

rg-acfm3unpnuw****
CenIdstring

云企业网实例的 ID。

cen-0xyeagctz5sfg9****
ProtectionLevelstring

网段重叠的级别。

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

REDUCED
Namestring

云企业网实例的名称。

nametest
Tagsobject []

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

Keystring

标签键。

tagtest
Valuestring

标签值。

tagtest
CenBandwidthPackageIdsarray

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

string

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

cenbwp-4c2zaavbvh5f42****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidTagKeyThe tag keys are not valid.标签的Key值不合法。
400InvalidTagValueThe tag values are not valid.Tag value不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-03-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId