You need to enable JavaScript to run this app.
导航

DescribeCens

最近更新时间2024.01.12 10:22:11

首次发布时间2022.01.07 11:44:37

调用DescribeCens接口,查询符合要求的云企业网实例的详细信息。

使用说明

  • 若请求参数不传入CenIds,则会按照传入的其他参数查询,返回符合条件的云企业网实例。
  • 若请求参数中的非必选参数都不传入,则会按照当前登录账户查询,返回当前账户下的所有云企业网实例。
  • 使用标签过滤云企业网实例时,最多可查询指定标签关联的1000个云企业网实例。如果指定标签关联的云企业网实例超过1000个,则只返回前1000个。此时请使用ListTagsForResources接口查询。
  • a.N.b类型的参数中,“N”表示标签信息的序号,需按照数字顺序从1开始填写,单次调用数量上限10个。多个标签之间使用&分隔。

请求参数

名称类型是否必选示例值
描述
ActionStringDescribeCens要执行的操作,取值为DescribeCens。
VersionString2020-04-01API版本信息,当前版本为2020-04-01。

CenIds.N

String

CenIds.1= cen-7qthudw0ll6jmc****&CenIds.2=cen-13fszmm1xdssg3n6nu4x9****

云企业网实例的ID。您可以调用本接口获取云企业网实例ID。

  • 参数 - N:表示云企业网实例ID的序号,单次调用数量上限100个。
  • 多个云企业网实例ID之间用&分隔。
CenNameStringcen-test-001云企业网实例的名称。
PageNumberInteger1列表的页码。默认值为1。
PageSizeInteger20分页查询时每页的行数。取值范围为1~100,默认值为20。

ProjectName

String

default

云企业网实例所属项目的名称。

  • 该参数不传入或传入为空时,表示查询所有的云企业网实例。
  • 该参数传入不为空时,表示查询属于指定项目的云企业网实例。

TagFilters.N.Key

String

TagFilters.1.Key=k1&TagFilters.2.Key=k2

云企业网实例标签的标签键。
指定多个标签键时,表示查询同时包含所有指定标签键的云企业网实例。

TagFilters.N.Values.N

String

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3

云企业网实例标签的标签值。每个标签键最多可指定3个标签值。

  • 未传入该参数时,表示查询指定标签键下所有标签值对应的标签所关联的云企业网实例。
  • 该参数取值为空时,表示查询指定标签键下标签值为空的标签所关联的云企业网实例。
  • 同一个标签键指定多个标签值时,表示查询各个标签值对应标签所关联云企业网实例的集合。

如果传入该参数,则必须先传入TagFilters.N.Key

返回参数

名称类型示例值
描述
RequestIdString202111161611080102121461940900****请求ID。
TotalCountInteger10满足指定条件的云企业网实例总数。
PageNumberInteger1当前页码。
PageSizeInteger20当前分页的行数。
CensArray of Struct-云企业网实例的详细信息。具体请参见下表“Cens”。

Cens

名称类型示例值
描述
CenIdStringcen-7qthudw0ll6jmc****云企业网实例的ID。
CenNameStringcen-test云企业网实例的名称。
AccountIdString210000****云企业网实例所属的账号ID。
DescriptionStringThis is a sample description云企业网实例的描述。
CreationTimeString2021-04-09T08:36:47+08:00创建云企业网实例的时间。
UpdateTimeString2021-04-10T09:18:28+08:00更新云企业网实例的时间。

Status

String

Available

云企业网实例的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending:配置中
  • Available:可用

CenBandwidthPackageIds

List of String

["cbp-4c2zaavbvh5fx****", "cbp-13fszmm1x****"]

带宽包实例ID。

说明

云企业网实例未绑定带宽包时,该字段返回空。

ProjectNameStringdefault云企业网实例所属项目的名称。
TagsArray of Struct-云企业网的标签信息。具体请参见下表“Tag”。

Tag

名称类型示例值描述
KeyStringk1云企业网标签的标签键。
ValueStringv1云企业网标签的标签值。

请求示例

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