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

文档中心

立即注册

导航

ListTagsForResources

最近更新时间：2024.10.18 15:45:55首次发布时间：2022.09.02 08:48:37

调用 ListTagsForResources 接口，查询满足指定条件的云企业网资源的标签。

调试

API Explorer

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

去调试

请求参数

下表中，TagFilters.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，单次调用数量上限10个。多个标签之间使用&分隔。

参数名称	类型	是否必选	示例值	描述
Action	String	是	ListTagsForResources	要执行的操作，取值为ListTagsForResources。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ResourceType	String	是	cen	云企业网资源的类型，取值如下： cen：CEN实例。 cenbandwidthpackage：带宽包。
ResourceIds.N	String	否	ResourceIds.1=cen-273w3e33y2y9s7fap8u2j**&ResourceIds.2=cen-7qthudw0ll6jmc**	云企业网资源的ID。说明您可以调用 DescribeCens 接口，查询“cen”类型的资源ID。您可以调用 DescribeCenBandwidthPackages 接口，查询“cenbandwidthpackage”类型的资源ID。参数 - N：表示资源 ID的序号，单次调用数量上限50个。多个云企业网资源 ID之间使用&分隔。
TagType	String	否	custom	标签类型，取值如下： custom：用户标签。 system：系统标签。该参数可以为空，此时查询全部类型的标签。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	下一次查询开始的Token。
MaxResults	Integer	否	50	单次查询的数量，默认为 10，最大为100。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的资源。不允许重复。
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)”，即查询同一标签键下添加其中一个标签值的资源。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的资源。

返回参数

参数名称	类型	示例值	描述
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	根据 NextToken 判断是否具备下一个查询开始的 Token。取值：如果 NextToken 为空，表示没有下一个如果 NextToken 有值，则该值就是下一个查询开始的 Token
ResourceTags	Array of Struct	-	资源及其附加的标签信息。具体参见下表“ResourceTag结构”。

参数名称

类型

示例值

描述

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

根据 NextToken 判断是否具备下一个查询开始的 Token。取值：

如果 NextToken 为空，表示没有下一个
如果 NextToken 有值，则该值就是下一个查询开始的 Token

ResourceTags

Array of Struct

资源及其附加的标签信息。具体参见下表“ResourceTag结构”。

ResourceTag结构

参数名称	类型	示例值	描述
ResourceType	String	cen	云企业网资源的类型。 cen：表示CEN实例。 cenbandwidthpcakge：表示带宽包。
ResourceId	String	cen-273w3e33y2y9s7fap8u2j****	云企业网资源的ID。
TagKey	String	k1	云企业网资源附加标签的标签键。
TagValue	String	v1	云企业网资源附加标签的标签值。

请求示例

GET /?Action=ListTagsForResources&Version=2020-04-01&ResourceType=cen HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "ListTagsForResources",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result": {
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "ResourceTags": [
            {
                "ResourceType": "cen",
                "ResourceId": "cen-273w3e33y2y9s7fap8u2j****",
                "TagKey": "k1",
                "TagValue": "v1"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询NextToken不合法。
400	InvalidResourceType.Malformed	The specified parameter resource type is invalid.	资源类型不合法。
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	InvalidTagType.Malformed	The specified parameter tag type is invalid.	标签类型不合法。
400	LimitExceeded.Resource	You've reached the limit on the number of resources that you can operate at a time.	已达到单次可操作资源数量的上限。
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.	已达到单次可指定过滤标签值数量的上限。
404	InvalidResource.NotFound	The specified resource does not exist.	指定的资源不存在。