You need to enable JavaScript to run this app.
文档中心
云企业网

云企业网

复制全文
下载 pdf
云企业网实例
DescribeCens - 查询云企业网实例的列表
复制全文
下载 pdf
DescribeCens - 查询云企业网实例的列表
调用 DescribeCens 接口,查询满足指定条件的的云企业网实例。​
使用说明​
  • 若请求参数不传入CenIds,则会按照传入的其他参数查询,返回符合条件的云企业网实例。​
  • 若请求参数中的非必选参数都不传入,则会按照当前登录账户查询,返回当前账户下的所有云企业网实例。​
  • 使用标签过滤云企业网实例时,最多可查询指定标签关联的1000个云企业网实例。如果指定标签关联的云企业网实例超过1000个,则只返回前1000个。此时请使用ListTagsForResources接口查询。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeCens​
要执行的操作,取值:DescribeCens。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
CenName string 可选 示例值:cen-test-001​
CEN实例的名称。​
​
PageNumber integer 可选 示例值:1​
列表的页码。默认值为1。​
​
PageSize integer 可选 示例值:20​
分页查询时每页的行数。取值范围为1~100,默认值为20。​
​
TagFilters.N.Key string[] 可选 示例值:k1​
标签的标签键。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的CEN。​
  • 不允许重复。​
​
TagFilters.N.Values.N string[] 可选 示例值:v1​
标签的标签值。​
  • 第一个N:表示标签键的序号,取值范围:1~10。​
  • 第二个N:表示标签值的序号,取值范围:1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的CEN。​
  • 多个标签值之间用&分隔。​
  • 若传入该参数,则必须先传入TagFilters.N.Key。​
  • 传入空字符串时,表示查询标签值为空的CEN。​
​
ProjectName string 可选 示例值:default​
CEN实例所属项目的名称。​
​
CenIds.N string[] 可选 示例值:cen-7qthudw0ll6jmc****​
CEN实例的ID。​
  • 参数 - N:表示CEN实例ID的序号,单次调用数量上限100个。​
  • 多个CEN实例ID之间用&分隔。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
TotalCount integer 示例值:10​
满足指定条件的CEN实例总数。​
​
PageNumber integer 示例值:1​
当前页码。​
​
PageSize integer 示例值:20​
当前分页的行数。​
​
Cens object[] 示例值:--​
CEN实例的详细信息。​
CenName string 示例值:cen-test​
CEN实例的名称。​
​
Description string 示例值:This is a sample description​
CEN实例的描述。​
​
CreationTime string 示例值:2021-04-09T08:36:47+08:00​
创建CEN实例的时间。​
​
UpdateTime string 示例值:2021-04-10T09:18:28+08:00​
更新CEN实例的时间。​
​
Status string 示例值:Available​
CEN实例的状态。​
  • Creating: 创建中​
  • Deleting: 删除中​
  • Pending:配置中​
  • Available:可用​
​
ProjectName string 示例值:default​
CEN实例所属项目的名称。​
​
Tags object[] 示例值:--​
标签信息。​
Value string 示例值:v1​
标签的标签值。​
​
Key string 示例值:k1​
标签的标签键。​
​
​
CenId string 示例值:cen-7qthudw0ll6jmc****​
CEN实例的ID。​
​
AccountId string 示例值:210000****​
CEN实例所属的账号ID。​
​
CenBandwidthPackageIds string[] 示例值:cbp-4c2zaavbvh5fx****​
带宽包ID。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeCens&Version=2020-04-01 HTTP/1.1​
Host: cen.volcengineapi.com​
X-Date: 20260109T083910Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260109/cn-beijing/cen/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20250818103354178137233114E3F098",​
"Action": "DescribeCens",​
"Version": "2020-04-01",​
"Service": "cen",​
"Region": "cn-beijing"​
},​
"Result": {​
"TotalCount": 10,​
"PageNumber": 1,​
"PageSize": 20,​
"Cens": [​
{​
"CenName": "cen-test",​
"Description": "This is a sample description",​
"CreationTime": "2021-04-09T08:36:47+08:00",​
"UpdateTime": "2021-04-10T09:18:28+08:00",​
"Status": "Available",​
"ProjectName": "default",​
"Tags": [​
{​
"Value": "v1",​
"Key": "k1"​
}​
],​
"CenId": "cen-7qthudw0ll6jmc****",​
"AccountId": "210000****",​
"CenBandwidthPackageIds": [​
"cbp-4c2zaavbvh5fx****"​
]​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.​
该请求缺少必要参数。请确保您发起请求时已传入全部必要参数。​
400​
InvalidParameter​
A parameter specified in the request is not valid, is unsupported or cannot be used.​
该请求传入了非法或不支持的参数。​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
LimitExceeded.ResourceIds​
You've reached the limit of 100 resource IDs that can be specified in this request.​
已达到单次可查询的实例数量上限。​
400​
InvalidTagFilterKey.Malformed​
The specified parameter tag filter key is invalid.​
过滤标签键不合法。​
400​
InvalidTagFilterValue.Malformed​
The specified parameter tag filter value is invalid.​
过滤标签值不合法。​
400​
LimitExceeded.TagFilterKey​
You've reached the limit on the number of tag keys that you can filter.​
已达到单次可指定过滤标签键数量的上限。​
400​
LimitExceeded.TagFilterValue​
You've reached the limit on the number of tag values that you can filter.​
已达到单次可指定过滤标签值数量的上限。​
400​
InvalidTagFilter.Disorder​
The specified index order of tag filter is malformed.​
指定标签过滤项的索引顺序参数格式不合法。​
500​
InternalError​
Request failed with internal server error.​
系统内部错误。​
​
​
最近更新时间:2026.04.03 11:15:34
这个页面对您有帮助吗?
有用
有用
无用
无用