API 名称：ListTagsForResources 。
API 域名：open.volcengineapi.com 。
API 描述：查询资源的用户标签。
节流限制：每秒最多提交 50 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数 。
| 名称 | 类型 | 是否必选 | 格式 | 说明 |
|---|---|---|---|---|
| Action | string | 是 | [a-zA-Z]+ | API 名称，如 ListTagsForResources 。 |
| Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
| X-Expires | int | 否 | 900 | 表示签名的有效时间，单位是秒，默认值是900。 |
| 参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
|---|---|---|---|---|
ResourceType | String | 是 | 资源类型。取值范围：
| loadbalancer |
ResourceIds.N | List of String | 否 | 资源的ID。参数 - N：表示资源 ID的序号，单次调用数量上限50个。多个资源 ID之间使用 & 分隔。 | ResourceIds.1=alb-273sdsdsxxxxxp8u2j****&ResourceIds.2=alb-2fe6fszjgeznk5oxruv0u**** |
| MaxResults | Integer | 否 | 单次查询的数量，默认为 10，最大为100。 | 10 |
NextToken | String | 否 | 分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。 | OTk5OTk5OQ== |
| TagFilters | Array | 否 | 标签列表，单次操作数量上限 10个，具体参见下表 TagFilters。 | - |
TagFilters
| 参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
|---|---|---|---|---|
TagFilters.N.Key | String | 否 | 根据标签查询资源时指定的标签键。参数-N：表示标签键的序号，单次调用数量上限10个。 多个标签键之间使用&分隔。 指定多个标签键时，表示查询同时包含所有指定标签键的资源。 | TagFilters.1.Key=k1&TagFilters.2.Key=k2 |
TagFilters.N.Values.N | List of String | 否 | 资源标签的标签值。每个标签键最多可指定3个标签值。未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的资源。 同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联资源的集合。
| TagFilters.1.Values.1=v1&TagFilters.2.Values.1=v4 |
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
RequestId | String | 请求ID。 | 2021062415303301022514515207C4**** |
| NextToken | String | 本次调用返回的查询凭证值，返回为空表示没有下一页。 | OTk5OTk5OQ== |
| ResourceTags | Array | 资源及其附加的标签信息。具体参见下表 ResourceTags。 |
ResourceTags
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
| ResourceType | String | 资源的类型。 | listener |
| ResourceId | String | 资源的ID。 | alb-2e0b1cayeha81fi56***** |
| TagKey | String | 资源附加标签的标签键。 | K1 |
| TagValue | String | 资源附加标签的标签值。 | val1 |
GET /?Action=ListTagsForResources&Version=2020-04-01&ResourceType=loadbalancer&ResourceIds.1=alb-2e0b1cayeha81fi56cp*****&ResourceIds.2=alb-1tzhdsteithq84gwgtb***** Host: open.volcengineapi.com Service: alb Region: cn-beijing
{ "ResponseMetadata": { "RequestId": "2024112415303301022514515207C4****", "Action": "ListTagsForResources", "Version": "2020-04-01", "Service": "alb", "Region": "cn-beijing" }, "Result": { "RequestId": "2024112415303301022514515207C4****", "NextToken": "hj4l32hj4gjvgo430f5****", "ResourceTags": [ { "ResourceType": "loadbalancer", "ResourceId": "alb-2e0b1cayeha81fi56cp*****", "TagKey": "k1", "TagValue": "v1" }, { "ResourceType": "loadbalancer", "ResourceId": "alb-1tzhdsteithq84gwgtb*****", "TagKey": "k2", "TagValue": "v2" } ] } }
如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。
| HTTP Code | 错误码 | 错误信息 | 错误描述 |
|---|---|---|---|
400 | LimitExceed.Resource | You've reached the limit on the number of resources that you can operate at a time. | 已达到单次可操作的资源的数量上限。 |
400 | InvalidResourceType.Malformed | The specified ResourceType is malformed. | 指定的 ResourceType 参数格式不合法。 |
| 400 | MissingParameter | The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'ResourceType'. | 该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: ResourceType。 |
| 400 | InvalidIndexOrder.Malformed | The specified index order is malformed. | 指定的索引顺序参数格式不合法。 |
| 400 | InvalidTags.Key.Malformed | The specified Tags.Key is malformed. | 指定的 Tags.Key 参数格式不合法。 |
| 400 | InvalidTags.Value.Malformed | The specified Tags.Value is malformed. | 指定的 Tags.Value 参数格式不合法。 |
| 400 | InvalidTags.Key.Duplicated | The specified Tags.Key is duplicated. | 指定的 Tags.Key 重复。 |
| 404 | InvalidResource.NotFound | The specified Resource does not exist. | 指定的资源不存在。 |