ListTagResources - 查询资源绑定的标签列表

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

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。

调用 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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:ListTagResourcesget
*全部资源
*
  • mq:QueryInstanceBaseInfo

请求参数

名称类型必填描述示例值
InstanceIdstring

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

说明 如果您需查询的是 Topic、Group 的标签,则必须填写该参数。
MQ_INST_188077086902****_BXSuW61e
ResourceTypestring

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

  • INSTANCE
  • TOPIC
  • GROUP
TOPIC
NextTokenstring

下一页查询开始的 Token。

caeba0****be03f84eb48b699f0a4883
Tagarray<object>

标签列表。列表元素个数不得超过 20。

object
Keystring

资源的标签键。

  • 若输入该参数,则参数取值不允许为空字符串。
  • 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://
CartService
Valuestring

资源的标签值。

  • 若输入该参数,参数取值允许为空字符串。
  • 最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://
ServiceA
ResourceIdarray

资源 ID 列表。

string

需要查询的资源 ID。

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

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

  • 当需要查询的标签绑定的资源类型为 Group 时,该参数输入 Group ID。

test

返回参数

名称类型描述示例值
object
NextTokenstring

下一页查询开始的 Token。

caeba0****be03f84eb48b699f0a4883
RequestIdstring

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

301D2CBE-66F8-403D-AEC0-82582478****
TagResourcesarray<object>

由资源及其标签组成的集合,包含了资源 ID、资源类型和标签键值等信息。

TagResourceobject
ResourceTypestring

资源类型。

  • ALIYUN::MQ::INSTANCE:表示资源类型为实例。
  • ALIYUN::MQ::TOPIC:表示资源类型为 Topic。
  • ALIYUN::MQ::GROUP:表示资源类型为 Group。
ALIYUN::MQ::TOPIC
InstanceIdstring

实例 ID。

MQ_INST_188077086902****_BXSuW61e
TagValuestring

标签值。

ServiceA
ResourceIdstring

资源 ID。

TopicA
TagKeystring

标签键。

CartService

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史

控制台操作

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