调用ListTagResources接口查询一个或多个PolarDB集群已绑定的标签列表,或者查询一个或多个标签绑定的PolarDB集群列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTagResources

系统规定参数。取值:ListTagResources

RegionId String cn-hangzhou

地域ID,您可以通过接口DescribeRegions查看可用的地域ID。

ResourceType String cluster

资源类型定义,取值固定为cluster

NextToken String 212db86sca4384811e0b5e8707e******

用来返回更多结果。第一次查询不需要提供这个参数,如果第一次查询没有返回全部结果,则可在后续查询中传入前一次返回的token继续查询。

ResourceId.N String pc-****************

目标集群ID。若您需要查询多个集群的标签情况,请单击添加来添加目标集群ID。

说明
  • ResourceId.N参数和Tag.N.Key参数至少传入一个。
  • 若选择传入ResourceId.N参数,则每次最多添加50个集群ID。
Tag.N.Key String type

标签键。若您需要查询多个标签下的所有目标集群详情,请单击添加来添加标签。

说明
  • ResourceId.N参数和Tag.N.Key参数至少传入一个。
  • 若选择传入Tag.N.Key参数,则每次最多添加20对标签。
Tag.N.Value String test

标签键对应的标签值,允许传入空字符串。

返回数据

名称 类型 示例值 描述
NextToken String 212db86sca4384811e0b5e8707e******

用来返回更多结果。如果一次查询没有返回全部结果,则会返回该参数。您可以在后续查询中传入前一次返回的token继续查询。

RequestId String 688C04E4-23F8-409F-8A38-B954D5******

请求ID。

TagResources Array of TagResource

查询到的集群和标签的信息。

TagResource
ResourceType String cluster

资源类型,取值固定为cluster

TagValue String test

标签键对应的标签值。

ResourceId String pc-****************

集群ID。

TagKey String type

标签键。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&ResourceType=cluster
&NextToken=212db86sca4384811e0b5e8707e******
&ResourceId=[]
&Tag=[{"Key":"type","Value":"test"}]
&<公共请求参数>

正常返回示例

XML格式

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

<ListTagResourcesResponse>
<RequestId>688C04E4-23F8-409F-8A38-B954D5******</RequestId>
<TagResources>
    <TagResource>
        <ResourceId>pc-***************</ResourceId>
        <TagKey>type</TagKey>
        <ResourceType>cluster</ResourceType>
        <TagValue>test</TagValue>
    </TagResource>
</TagResources>
</ListTagResourcesResponse>

JSON格式

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

{
  "RequestId" : "688C04E4-23F8-409F-8A38-B954D5******",
  "TagResources" : {
    "TagResource" : [ {
      "ResourceId" : "pc-***************",
      "TagKey" : "type",
      "ResourceType" : "cluster",
      "TagValue" : "test"
    } ]
  }
}

错误码

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