You need to enable JavaScript to run this app.
导航
中转路由器
  • 文档首页
    • /
  • 中转路由器

ListTagsForResources

最近更新时间：2024.04.23 10:47:47

首次发布时间：2023.11.10 10:02:49

我的收藏

调用ListTagsForResources接口，查询满足指定条件的标签信息。

使用说明

a.N.b类型的参数中，“N”表示根据标签查询资源时标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～10。多个标签之间使用&分隔。

请求参数

下表中，TagFilters.N.a类型参数中的“N”表示根据标签查询资源时标签信息的序号，需按照数字顺序从1开始填写，取值范围为1～10。多个标签之间使用&分隔。

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

ResourceType

String

是

transitrouter

资源的类型，取值如下：

  • transitrouter：中转路由器实例。
  • transitrouterroutetable：TR路由表。
  • transitrouterattachment：实例连接，包括VPC、VPN、专线网关类型网络实例连接和跨地域连接。
  • transitrouterbandwidthpackage：中转路由器带宽包。

ResourceIds.N

String

否

ResourceIds.1=tr-273sdsdsxxxxxp8u2j****&ResourceIds.2=tr-2fe6fszjgeznk5oxruv0u****

资源的ID。

  • 参数 - N：表示资源 ID的序号，单次调用数量上限50个。
  • 多个资源 ID之间使用&分隔。

说明

TagType

String

否

custom

标签类型，取值如下：

  • custom：用户标签。
  • system：系统标签。
  • 该参数可以为空，此时查询全部类型的标签。

TagFilters.N.Key

String

否

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

根据标签查询资源时指定的标签键。

  • 参数 - N：表示标签键的序号，单次调用数量上限10个。多个标签键之间使用&分隔。
  • 指定多个标签键时，表示查询同时包含所有指定标签键的资源。

说明

传入的TagFilters.N.Key不存在时，返回空。

TagFilters.N.Values.M

String

否

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

资源标签的标签值。

  • 参数 - M：表示标签值的序号，单次调用每个标签键最多可指定3个标签值。
  • 未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的中转路由器资源。
  • 该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的中转路由器资源。
  • 同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联中转路由器资源的集合。

说明

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

NextTokenString否caeba0bbb2be03f84eb48b699f0a****分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。
MaxResultsInteger否50单次查询的数量，默认为 10，最大为100。

返回参数

名称类型示例值描述
RequestIdString2021062415303301022514515207C4****请求ID。
NextTokenStringcaeba0bbb2be03f84eb48b699f0a****本次调用返回的查询凭证值，返回为空表示没有下一页。
ResourceTagsArray of Struct-资源及其附加的标签信息。具体参见下表“ResourceTags”。

ResourceTags

名称类型示例值描述

ResourceType

String

transitrouter

资源的类型。

  • transitrouter：中转路由器实例。
  • transitrouterroutetable：TR路由表。
  • transitrouterattachment：实例连接，包括VPC、VPN、专线网关类型网络实例连接和跨地域连接。
  • transitrouterbandwidthpackage：中转路由器带宽包。
ResourceIdStringtr-2fe6fszjgeznk5oxruv0u****资源的ID。
TagKeyStringk1资源附加标签的标签键。
TagValueStringv1资源附加标签的标签值。

请求示例

GET /?Action=ListTagsForResources&Version=2020-04-01&ResourceType=transitrouter&ResourceIds.1=tr-273sdsdsxxxxxp8u2j****&ResourceIds.2=tr-2fe6fszjgeznk5oxruv0u**** HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "ListTagsForResources",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "ResourceTags": [
            {
                "ResourceType": "transitrouter",
                "ResourceId": "tr-273sdsdsxxxxxp8u2j****",
                "TagKey": "k1",
                "TagValue": "v1"
            },
            {
                "ResourceType": "transitrouter",
                "ResourceId": "tr-2fe6fszjgeznk5oxruv0u****",
                "TagKey": "k2",
                "TagValue": "v2"
            }
        ]
    }
}

错误码

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

HttpCode错误码错误信息描述
400LimitExceeded.ResourceYou've reached the limit on the number of resources that you can operate at one time.已达到单次可操作资源数量的上限。
400InvalidResourceType.MalformedThe specified parameter resource type is invalid.资源类型不合法。
400InvalidTagType.MalformedThe specified parameter tag type is invalid.标签类型不合法。
400InvalidTagKey.MalformedThe specified TagKey is invalid.指定的 TagKey 参数格式不合法。
400InvalidTagValue.MalformedThe specified TagValue is invalid.指定的 TagValue 参数格式不合法。
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.已达到单次可指定过滤标签值数量的上限。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询NextToken不合法。
400InvalidMaxResult.MalformedThe specified parameter MaxResult is malformed.查询数量不合法。
400InvalidIncorrectOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。