全部产品
Search
文档中心

消息队列Kafka版:ListTagResources - 查询资源绑定的标签列表

更新时间:Nov 22, 2022

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

调试

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

调试

授权信息

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

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

请求参数

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

资源的地域ID。

cn-hangzhou
ResourceTypestring

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

  • INSTANCE:实例。

  • TOPIC:主题。

  • CONSUMERGROUP:消费组

INSTANCE
NextTokenstring

下一个查询开始的Token。

caeba0bbb2be03f84eb48b699f0a4883
ResourceIdarray

打标的资源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。

说明ResourceIdTag参数必须配置其中任意一个,才能查询资源绑定的标签列表。否则,API调用失败。
string
Tagarray

标签列表。

object
Keystring

资源的标签键。

  • N为1~20。

  • 如果为空,则匹配所有标签键。

  • 最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

FinanceDept
Valuestring

资源的标签值。

  • N为1~20。

  • 如果标签键为空,则必须为空。为空时,匹配所有标签值。

  • 最多支持128个字符,不能以aliyun和acs:开头,不能包含http://或者https://。

FinanceJoshua

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询开始Token。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

DE65F6B7-7566-4802-9007-96F2494A****
TagResourcesarray

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

object
TagValuestring

标签值。

FinanceJoshua
ResourceTypestring

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

  • Instance

  • Topic

  • Consumergroup

instance
ResourceIdstring

打标的资源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****
TagKeystring

标签键。

FinanceDept

示例

正常返回示例

JSON格式

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

错误码

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