ListTagResources - 查询资源标签关系

更新时间:
复制 MD 格式

查询资源已经绑定的标签列表。当前支持实例 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:ListTagResources

get

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ResourceType

string

是

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

枚举值:

  • Instance :

    容器镜像服务实例

Instance

ResourceId

array

否

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

string

否

资源 ID。

cri-5w1ztcu2kruj****

RegionId

string

是

资源所在的地域 ID。

cn-hangzhou

Tag

array<object>

否

标签列表。

object

否

标签列表。

Key

string

否

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

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

test-key

Value

string

否

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

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

test-val

NextToken

string

否

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

AAAAAfj+3fkqd8igM6VLaQjlaYc=

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID

7FF809ED-B42F-5AC3-9A17-CFE14BE32A8E

TagResources

object

TagResource

array<object>

标签资源列表。

object

TagKey

string

标签的键。

test-key

TagValue

string

标签的值。

test-val

ResourceId

string

资源 ID

cri-w19e7qr2wibl****

ResourceType

string

资源类型

Instance

NextToken

string

是否拥有下一次查询的令牌(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

错误码

错误信息

描述

400 SystemError A system error occurred while processing your request 系统异常。
400 InvalidParameter.ResourceType The ResourceType parameter is invalid.
400 MissingParameter.ResourceIdsOrTags You must specify ResourceId.N or Tags.
400 MissingParameter.ResourceType You must specify ResourceType.
400 MissingParameter.TagKey You must specify Tag.N.Key.
400 NumberExceed.ResourceIds The maximum number of ResourceIds is exceeded.
400 NumberExceed.Tags The maximum number of Tags is exceeded.
400 Duplicate.TagKey The Tag.N.Key contains duplicate keys.
400 InvalidParameter.NextToken The NextToken parameter is invalid.
403 NoPermission The operator is not permission for this operate

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

变更历史

更多信息,参考变更详情。