查询资源标签列表 - API参考| 阿里云

调试

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

请求语法

GET /tags?resource_ids=["String"]&resource_type=String&region_id=String&tags=[{"key":"String","value":"String"}]&next_token=String HTTP/1.1
Content-Type:application/json

请求参数

表 1. 请求Query参数
参数名称	类型	是否必选	示例	说明
resource_ids	Array of String	是	c71cf3d796c374bf48644482cb0c3****	集群ID。
resource_type	String	是	CLUSTER	资源类型，目前支持：`CLUSTER`。
region_id	String	是	cn-beijing	地域ID。
tags	Array of tag	否		要查询的标签列表，限制最多包含20个子项。
next_token	String	否	***	下一个查询开始的令牌。

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "next_token" : "String",
  "request_id" : "String",
  "tag_resources" : {
    "tag_resource" : [ {
      "tag_key" : "String",
      "tag_value" : "String",
      "resource_id" : "String",
      "resource_type" : "String"
    } ]
  }
}

响应参数

表 2. 响应Body参数
参数名称	类型	示例	说明
next_token	String	c374bf4864448****	下一个查询开始的令牌。
request_id	String	E368C761-F8F6-4A36-9B58-BD53D5CD0CEB	请求ID。
tag_resources	object		标签资源集。
tag_resource	Array of tag_resource		标签资源。
tag_key	String	ack.aliyun.com	标签的名称。
tag_value	String	c71cf3d796c374bf48644482cb0c3****	标签值。
resource_id	String	i-xxx	资源ID。
resource_type	String	CLUSTER	资源类型。更多信息，请参见标签。

查询资源标签列表示例

请求示例

GET /tags?resource_ids=["c71cf3d796c374bf48644482cb0c3****"]&resource_type=CLUSTER&region_id=cn-beijing&tags=[{"key":"env","value":"prod"}]&next_token=*** HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<next_token>c374bf4864448****</next_token>
<request_id>E368C761-F8F6-4A36-9B58-BD53D5CD0CEB</request_id>
<tag_resources>
    <tag_resource>
        <tag_key>ack.aliyun.com</tag_key>
        <tag_value>c71cf3d796c374bf48644482cb0c3****</tag_value>
        <resource_id>i-xxx</resource_id>
        <resource_type>CLUSTER</resource_type>
    </tag_resource>
</tag_resources>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "next_token" : "c374bf4864448****",
  "request_id" : "E368C761-F8F6-4A36-9B58-BD53D5CD0CEB",
  "tag_resources" : {
    "tag_resource" : [ {
      "tag_key" : "ack.aliyun.com",
      "tag_value" : "c71cf3d796c374bf48644482cb0c3****",
      "resource_id" : "i-xxx",
      "resource_type" : "CLUSTER"
    } ]
  }
}

错误码

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