DescribeCens--云企业网-火山引擎

文档中心

立即注册

导航

DescribeCens

最近更新时间：2024.10.18 15:38:02首次发布时间：2022.01.07 11:44:37

调用 DescribeCens 接口，查询满足指定条件的的云企业网实例。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

使用说明

若请求参数不传入CenIds，则会按照传入的其他参数查询，返回符合条件的云企业网实例。
若请求参数中的非必选参数都不传入，则会按照当前登录账户查询，返回当前账户下的所有云企业网实例。
使用标签过滤云企业网实例时，最多可查询指定标签关联的1000个云企业网实例。如果指定标签关联的云企业网实例超过1000个，则只返回前1000个。此时请使用ListTagsForResources接口查询。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCens	要执行的操作，取值为DescribeCens。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
CenIds.N	String	否	CenIds.1= cen-7qthudw0ll6jmc**&CenIds.2=cen-13fszmm1xdssg3n6nu4x9**	CEN实例的ID。参数 - N：表示CEN实例ID的序号，单次调用数量上限100个。多个CEN实例ID之间用&分隔。
CenName	String	否	cen-test-001	CEN实例的名称。
ProjectName	String	否	default	CEN实例所属项目的名称。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的CEN。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1	标签的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的CEN。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的CEN。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数。取值范围为1～100，默认值为20。

返回参数

参数名称	类型	示例值	描述
TotalCount	Integer	10	满足指定条件的CEN实例总数。
PageNumber	Integer	1	当前页码。
PageSize	Integer	20	当前分页的行数。
Cens	Array of Struct	-	CEN实例的详细信息。具体请参见下表“Cen结构”。

Cen结构

参数名称	类型	示例值	描述
CenId	String	cen-7qthudw0ll6jmc****	CEN实例的ID。
CenName	String	cen-test	CEN实例的名称。
AccountId	String	210000****	CEN实例所属的账号ID。
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：可用
CenBandwidthPackageIds	List of String	["cbp-4c2zaavbvh5fx**", "cbp-13fszmm1x**"]	带宽包ID。说明 CEN实例未绑定带宽包时，该字段返回空。
ProjectName	String	default	CEN实例所属项目的名称。
Tags	Array of Struct	-	标签信息。具体请参见下表“Tag”。

Tag

参数名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

请求示例

GET /?Action=DescribeCens&Version=2020-04-01&CenIds.1=cen-7qthudw0ll6jmc****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222112033010224****",
        "Action": "DescribeCens",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {
		    "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "Cens": [
				    {
						    "CenId": "cen-7qthudw0ll6jmc****",
                "CenName": "abc",
                "AccountId": "210000****",
								"Description": "This is a sample description",
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Available",
                "CenBandwidthPackageIds": [
                    "cbp-4c2zaavbvh5fx****",
                    "cbp-13fszmm1x****"
				        ],
								"ProjectName": "default", 
								"Tags": [ 
								    { 
								        "Key": "k1", 
								        "Value": "v1" 
							      }, 
							      { 
							          "Key": "k2", 
							          "Value": "v2" 
                    } 
                ]
            }
        ]
		}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	已达到单次可查询的实例数量上限。
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.	已达到单次可指定过滤标签值数量的上限。