ListTagsForResources--中转路由器-火山引擎

文档中心

立即注册

导航

ListTagsForResources

最近更新时间：2024.09.10 10:14:49首次发布时间：2023.11.10 10:02:49

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListTagsForResources	要执行的操作，取值为ListTagsForResources。
Version	String	是	2020-04-01	API版本信息，当前版本为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的序号，取值范围 1～50。多个资源 ID之间使用&分隔。说明您可以调用DescribeTransitRouters接口获取“transitrouter”类型资源的ID。您可以调用DescribeTransitRouterRouteTables接口获取“transitrouterroutetable”类型资源的D。您可以根据待添加标签资源的类型，分别调用DescribeTransitRouterVpcAttachments、DescribeTransitRouterVpnAttachments、DescribeTransitRouterDirectConnectGatewayAttachments或DescribeTransitRouterPeerAttachments接口获取“transitrouterattachment”类型资源的ID。您可以调用DescribeTransitRouterBandwidthPackages接口获取“transitrouterbandwidthpackage”类型资源的ID。
TagType	String	否	custom	标签类型，取值如下： custom：用户标签。 system：系统标签。该参数可以为空，此时查询全部类型的标签。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2	根据标签查询资源时指定的标签键。 N：表示标签键的序号，取值范围 1～10。多个标签键之间使用&分隔。指定多个标签键时，表示查询同时包含所有指定标签键的资源。说明传入的`TagFilters.N.Key`不存在时，返回空。
TagFilters.N.Values.N	String	否	TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3	资源标签的标签值。第一个N：表示标签键的序号，取值范围 1～10。第二个N：表示标签值的序号，取值范围 1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的资源。多个标签值之间使用&分隔。说明如果传入该参数，则必须先传入`TagFilters.N.Key`。该参数传入空值时，表示查询指定标签键下标签值为空的资源。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
MaxResults	Integer	否	50	单次查询的数量，默认为 10，最大为100。

返回参数

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

ResourceTags

名称	类型	示例值	描述
ResourceType	String	transitrouter	资源的类型。 transitrouter：中转路由器实例。 transitrouterroutetable：TR路由表。 transitrouterattachment：实例连接，包括VPC、VPN、专线网关类型网络实例连接和跨地域连接。 transitrouterbandwidthpackage：中转路由器带宽包。
ResourceId	String	tr-2fe6fszjgeznk5oxruv0u****	资源的ID。
TagKey	String	k1	资源附加标签的标签键。
TagValue	String	v1	资源附加标签的标签值。

请求示例

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