ListTagResources - 获取资源标签列表

更新时间:
复制 MD 格式

获取资源标签列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListTagResources

none

*全部资源

*

请求语法

GET /v1/tags HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ResourceType

string

资源类型注意:虽然文档标注默认值为 Gateway,但实际调用时必须显式传入此参数,否则 API 返回 InvalidParameter.UnsupportedTagResourceType(400)。当前允许值:Gateway。

Gateway

ResourceId

array

资源 ID,最多 50 个子项,ResourceId 与 Tag 至少须提供其一,两者均为空时 API 返回 InvalidParameter.BothEmpty(400)。

["gw-xxx","gw-yyy"]

string

单个资源 ID。当前支持网关资源,取值为网关 ID。

["gw-xxx","gw-yyy"]

Tag

array<object>

对应新增标签列表,最多包含 20 个子项,ResourceId 与 Tag 至少须提供其一,两者均为空时 API 返回 InvalidParameter.BothEmpty(400)。

[{"key":"env","value":"prod"}]

object

object

Key

string

标签键

env

Value

string

标签值

prod

NextToken

string

下一个查询开始 Token

caeb235b-xxx

返回参数

名称

类型

描述

示例值

object

NextToken

string

下一个查询开始 Token,NextToken 为空说明没有下一个

caeb235b-xxx

RequestId

string

请求 ID

59F86F37-787A-52DB-9475-DB5A255517F0

TagResources

array<object>

资源列表

object

object

ResourceType

string

资源类型

gateway

TagValue

string

标签值

prod

ResourceId

string

资源 ID

gw-xxx

TagKey

string

标签键

env

示例

正常返回示例

JSON格式

{
  "NextToken": "caeb235b-xxx",
  "RequestId": "59F86F37-787A-52DB-9475-DB5A255517F0",
  "TagResources": [
    {
      "ResourceType": "gateway",
      "TagValue": "prod",
      "ResourceId": "gw-xxx",
      "TagKey": "env"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情