调用DescribeCens接口查询当前阿里云账号下的云企业网实例的状态、是否已开启IPv6功能、实例绑定的带宽包的列表等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:DescribeCens | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 否 | 待查询的页码。默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时每页显示的条目数。取值范围:1~50。默认值:10。 | 10 |
ResourceGroupId | string | 否 | 云企业网实例所属的资源组 ID。 | rg-acfm3unpnuw**** |
Filter | array<object> | 否 | 过滤条件的信息。 一次最多支持输入 5 个过滤条件。 | |
object | 否 | |||
Key | string | 否 | 过滤条件。取值:
多个过滤条件之间默认是与的关系,即必须符合所有过滤条件,才视为匹配过滤条件。 一次最多支持输入 5 个过滤条件。 | CenId |
Value | array | 否 | 过滤条件的值。 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,多个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 一个过滤条件最多支持输入 5 个过滤值。 | |
string | 否 | 过滤条件的值。 根据 Key 指定过滤值。一个 Key 支持指定多个过滤值,多个过滤值之间是或的关系,即只要符合其中一个过滤值,则视为匹配该过滤条件。 一个过滤条件最多支持输入 5 个过滤值。 | cen-44m0p68spvlrqq**** | |
Tag | array<object> | 否 | 标签信息。 一次最多支持输入 20 个标签信息。 | |
object | 否 | |||
Key | string | 否 | 资源的标签键。 一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 一次最多支持输入 20 个标签的标签键。 | tagtest |
Value | string | 否 | 资源的标签值。 标签值可以为空或输入不超过 128 个字符的字符串,不能以 每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。 | tagtest |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidTagKey | The tag keys are not valid. | 标签的Key值不合法。 |
400 | InvalidTagValue | The tag values are not valid. | Tag value不合法。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |