全部产品
Search
文档中心

API 网关:ListTagResources - 用户查询标签接口

更新时间:Mar 01, 2024

查询可见的资源标签关系。

接口说明

  • 对于 Tag.N.Key 及 Tag.N.Value 中相同的 N 是一对键值对。
  • ResourceId.N 需满足所有输入的键值对。当输入多个键值对,查询结果为资源中包含指定多个键值对的资源。
  • 查询返回符合条件的标签资源关系,当过滤后没有匹配的资源标签关系则返回空列表。
  • 用户同时查询用户标签跟可见系统标签。
  • 除必填参数传入外,传入 ResourceId.N,查询某个 region 的指定资源的可见资源标签关系。
  • 除必填参数传入外,传入 Tag.N.Key,查询某个 region 的指定 Key 下的可见资源标签关系。
  • ResourceId.N 及 (Tag.N.Key,Tag.N.Value) 至少存在一个。
  • 单次操作,标签可以为相同类型的,也可以不同类型。
  • 用户对于用户标签全部的查询权限,用户有查询可见系统标签的权限。

调试

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

授权信息

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

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

请求参数

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

资源类型定义。

目前分组,插件,应用接入了标签,API 相关操作基于分组的标签:

  • apiGroup
  • plugin
  • app
  • api
apiGroup
NextTokenstring

下一个查询开始 Token

1d2db86sca4384811e0b5e8707e68181f
ResourceIdarray

资源 ID。

N 的取值范围为:[1, 50]

string
Tagobject []

指定规则所适用的对象标签,可设置多个。

Keystring

标签键。

N 的取值范围为:[1, 20]

env
Valuestring

标签值。当参数有值,要求对应的tag.N.Key在相同的 N 的标签键也传入值,否则会报错。

N 的取值范围为:[1, 20]

product

返回参数

名称类型描述示例值
object
NextTokenstring

下一个查询开始的 Token。

NextToken 为**-1**表示没有下一个。

1d2db86sca4384811e0b5e8707e68181f
RequestIdstring

请求 ID

2D69A58F-345C-4FDE-88E4-BF5189484043
TagResourcesobject []

资源列表

TagValuestring

标签值

zhangsan
ResourceTypestring

资源类型

apiGroup
ResourceIdstring

资源 ID

285bb759342649a1b70c2093a772e087
TagKeystring

标签键

owner

示例

正常返回示例

JSON格式

{
  "NextToken": "1d2db86sca4384811e0b5e8707e68181f",
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF5189484043",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "zhangsan",
        "ResourceType": "apiGroup",
        "ResourceId": "285bb759342649a1b70c2093a772e087",
        "TagKey": "owner"
      }
    ]
  }
}

错误码

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

变更历史

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