查询资源绑定的标签列表_云消息队列 Kafka 版(Kafka)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作

操作

访问级别

资源类型

条件关键字

关联操作

alikafka:ListTagResources

get

全部资源

无

请求参数

名称	类型	必填	描述	示例值

名称	类型	必填	描述	示例值
RegionId	string	是	资源的地域 ID。	cn-hangzhou
ResourceType	string	是	资源类型。枚举类型。取值： INSTANCE：实例。 TOPIC：主题。 CONSUMERGROUP：消费组。	INSTANCE
NextToken	string	否	下一个查询开始的 Token。	caeba0bbb2be03f84eb48b699f0a4883
ResourceId	array	否	打标的资源 ID 。资源 ID 规则：实例：instanceId Topic ：Kafka_alikafka_instanceId_topic Group：Kafka_alikafka_instanceId_consumerGroup 例如：实例 ID 为 alikafka_post-cn-v0h1fgs2xxxx、Topic 名称为 test-topic、Group 名称为 test-consumer-group，则各资源 ID 分别为 alikafka_post-cn-v0h1fgs2xxxx、Kafka_alikafka_post-cn-v0h1fgs2xxxx_test-topic、Kafka_alikafka_post-cn-v0h1fgs2xxxx_test-consumer-group。说明 ResourceId与Tag参数必须配置其中任意一个，才能查询资源绑定的标签列表。否则，API 调用失败。
	string	否	资源 ID。	alikafka_post-cn-v0h1fgs2****
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	资源的标签键。如果为空，则匹配所有标签键。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	FinanceDept
Value	string	否	资源的标签值。如果标签键为空，则必须为空。为空时，匹配所有标签值。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	FinanceJoshua

返回参数

名称	类型	描述	示例值

名称	类型	描述	示例值
NextToken	string	下一个查询开始 Token。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	DE65F6B7-7566-4802-9007-96F2494A****
TagResources	array<object>	由资源及其标签组成的集合，包含了资源 ID、资源类型和标签键值等信息。
TagValue	string	标签值。	FinanceJoshua
ResourceType	string	资源类型。枚举类型。取值： Instance Topic Consumergroup	Instance
ResourceId	string	打标的资源 ID 。资源 ID 规则：实例：instanceId Topic ：Kafka_alikafka_instanceId_topic Consumer Group：Kafka_alikafka_instanceId_consumerGroup 例如：实例 ID 为 alikafka_post-cn-v0h1fgs2xxxx、Topic 名称为 test-topic、Consumer Group 名称为 test-consumer-group，则各资源 ID 分别为 alikafka_post-cn-v0h1fgs2xxxx、Kafka_alikafka_post-cn-v0h1fgs2xxxx_test-topic、Kafka_alikafka_post-cn-v0h1fgs2xxxx_test-consumer-group。	alikafka_post-cn-v0h1fgs2****
TagKey	string	标签键。	FinanceDept

示例

正常返回示例

JSON格式

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494A****",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "ResourceType": "Instance",
        "ResourceId": "alikafka_post-cn-v0h1fgs2****",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

错误码

错误码请参见公共错误码。

变更历史

变更时间	变更内容概要	操作

变更时间	变更内容概要	操作
2024-08-15	OpenAPI 描述信息更新	查看变更详情
2023-11-09	API 内部配置变更，不影响调用	查看变更详情