文档

ListTagResources - 查询资源标签关系

更新时间:

查询资源已经绑定的标签列表。当前支持实例 Instance 资源。

接口说明

  • 请求中 ResourceId.N 及 (Tag.N.Key,Tag.N.Value) 至少存在一个,以确定检索对象。

  • Tag.N 是资源的标签,由一个键值对组成。仅指定 Tag.N.Key 时,则返回该标签键关联的所有标签值。仅指定 Tag.N.Value 会报错。

  • ResourceId.N 需满足所有输入的键值对。当输入多个键值对,查询结果为资源中包含指定多个键值对的资源。

调试

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

授权信息

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

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

请求参数

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

资源类型定义,当前支持实例 Instance 资源。

Instance
ResourceIdarray

资源 ID。最多支持添加 20 个资源。

string

资源 ID。

cri-5w1ztcu2kruj****
RegionIdstring

资源所在的地域 ID。

cn-hangzhou
Tagobject []

标签列表。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

test-key
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

test-val
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

AAAAAfj+3fkqd8igM6VLaQjlaYc=

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID

7FF809ED-B42F-5AC3-9A17-CFE14BE32A8E
TagResourcesobject []

标签资源列表。

TagKeystring

标签的键。

test-key
TagValuestring

标签的值。

test-val
ResourceIdstring

资源 ID

cri-w19e7qr2wibl****
ResourceTypestring

资源类型

Instance
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

AAAAAfj+3fkqd8igM6VLaQjlaYc=

示例

正常返回示例

JSON格式

{
  "RequestId": "7FF809ED-B42F-5AC3-9A17-CFE14BE32A8E",
  "TagResources": {
    "TagResource": [
      {
        "TagKey": "test-key\n",
        "TagValue": "test-val",
        "ResourceId": "cri-w19e7qr2wibl****",
        "ResourceType": "Instance"
      }
    ]
  },
  "NextToken": "AAAAAfj+3fkqd8igM6VLaQjlaYc=\n"
}

错误码

HTTP status code错误码错误信息描述
400SystemErrorA system error occurred while processing your request系统异常。
400InvalidParameter.ResourceTypeThe ResourceType parameter is invalid.-
400MissingParameter.ResourceIdsOrTagsYou must specify ResourceId.N or Tags.-
400MissingParameter.ResourceTypeYou must specify ResourceType.-
400MissingParameter.TagKeyYou must specify Tag.N.Key.-
400NumberExceed.ResourceIdsThe maximum number of ResourceIds is exceeded.-
400NumberExceed.TagsThe maximum number of Tags is exceeded.-
400Duplicate.TagKeyThe Tag.N.Key contains duplicate keys.-
400InvalidParameter.NextTokenThe NextToken parameter is invalid.-
403NoPermission The operator is not permission for this operate-

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

变更历史

变更时间变更内容概要操作
2024-04-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
  • 本页导读 (1)