调用ListTagResources查询资源绑定的标签列表。

使用说明

调用ListTagResources接口时，标签键Tag.N.Key和资源ID ResourceId.N至少需要输入一个。您可以查询某资源下的所有标签，也可以根据指定标签键查询标签值及标签所绑定的资源。

  • 若输入标签键Tag.N.Key，则可以查询标签值Tag.N.Value和标签所绑定的资源ID ResourceId.N。
  • 若输入资源ID ResourceId.N，则可以查询指定资源下所有的标签信息，包括标签键Tag.N.Key及标签值Tag.N.Value。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

授权信息

默认仅限阿里云账号使用本接口，RAM用户只有在被授予了相关API操作权限后方可使用。本接口的授权信息如下表所示。更多信息，请参见权限策略和示例。

API

Action

Resource

ListTagResources

mq:ListTagResources

acs:mq:*:*:*

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListTagResources

系统规定参数。取值：ListTagResources。

InstanceId String 否 MQ_INST_188077086902****_BXSuW61e

需查询的标签所绑定资源所在的实例ID。

说明 如果您需查询的是Topic、Group的标签，则必须填写该参数。
ResourceType String 是 TOPIC

资源类型。枚举类型。取值如下：

  • INSTANCE
  • TOPIC
  • GROUP
NextToken String 否 caeba0****be03f84eb48b699f0a4883

下一页查询开始的Token。
Tag.N.Key String 否 CartService

资源的标签键。

  • N的取值范围为1~20。
  • 若输入该参数，则参数取值不允许为空字符串。
  • 最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
Tag.N.Value String 否 ServiceA

资源的标签值。

  • N的取值范围为1~20。
  • 若输入该参数，参数取值允许为空字符串。
  • 最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
ResourceId.N String 否 test

需要查询的资源ID。

  • 当需要查询的标签绑定的资源类型为实例时，该参数输入实例ID。
  • 当需要查询的标签绑定的资源类型为Topic时，该参数输入Topic名称。
  • 当需要查询的标签绑定的资源类型为Group时，该参数输入Group ID。

返回数据

名称 类型 示例值 描述
NextToken String caeba0****be03f84eb48b699f0a4883

下一页查询开始的Token。
RequestId String 301D2CBE-66F8-403D-AEC0-82582478****

公共参数，每个请求的ID都是唯一的，可用于排查和定位问题。
TagResources Array of TagResource

由资源及其标签组成的集合，包含了资源ID、资源类型和标签键值等信息。
ResourceType String ALIYUN::MQ::TOPIC

资源类型。

  • ALIYUN::MQ::INSTANCE：表示资源类型为实例。
  • ALIYUN::MQ::TOPIC：表示资源类型为Topic。
  • ALIYUN::MQ::GROUP：表示资源类型为Group。
InstanceId String MQ_INST_188077086902****_BXSuW61e

实例ID。
TagValue String ServiceA

标签值。
ResourceId String TopicA

资源ID。
TagKey String CartService

标签键。

示例

请求示例

http(s)://ons.cn-hangzhou.aliyuncs.com/?Action=ListTagResources
&ResourceType=TOPIC
&ResourceId.1=TopicA
&InstanceId=MQ_INST_188077086902****_BXSuW61e
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTagResourcesResponse>
<RequestId>301D2CBE-66F8-403D-AEC0-82582478****</RequestId>
<NextToken>caeba0****be03f84eb48b699f0a4883</NextToken>
<TagResources>
    <ResourceId>TopicA</ResourceId>
    <InstanceId>MQ_INST_188077086902****_BXSuW61e</InstanceId>
    <TagKey>CartService</TagKey>
    <ResourceType>ALIYUN::MQ::TOPIC</ResourceType>
    <TagValue>ServiceA</TagValue>
</TagResources>
</ListTagResourcesResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "301D2CBE-66F8-403D-AEC0-82582478****",
  "NextToken" : "caeba0****be03f84eb48b699f0a4883",
  "TagResources" : {
    "ResourceId" : "TopicA",
    "InstanceId" : "MQ_INST_188077086902****_BXSuW61e",
    "TagKey" : "CartService",
    "ResourceType" : "ALIYUN::MQ::TOPIC",
    "TagValue" : "ServiceA"
  }
}

错误码

访问错误中心查看更多错误码。

控制台操作

除了调用ListTagResources接口，您还可以通过消息队列RocketMQ版控制台查看资源的标签信息。具体操作，请参见标签概述。