DescribeTags_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调用DescribeTags接口获取标签信息。

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTags	系统规定参数。取值：DescribeTags。
RegionId	String	是	cn-hangzhou	地域ID。
DBInstanceName	String	否	pxc-xxx	实例名称。
TagKey	String	否	test	标签Key。

返回数据

名称	类型	示例值	描述
RequestId	String	9B2F3840-5C98-475C-B269-2D5C3A31797C	请求ID。
TagInfos	Array of TagInfo		标签信息列表。
TagKey	String	testKey	标签Key。
TagValue	String	testValue	标签Value。
DBInstanceIds	Array of String	pxc-xxx	实例名称。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTags
&RegionId=cn-hangzhou
&DBInstanceName=pxc-xxx
&TagKey=test
&公共请求参数

正常返回示例

XML格式

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

<DescribeTagsResponse>
    <RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
    <TagInfos>
        <TagKey>testKey</TagKey>
        <TagValue>testValue</TagValue>
        <DBInstanceIds>pxc-xxx</DBInstanceIds>
    </TagInfos>
</DescribeTagsResponse>

JSON格式

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

{
  "RequestId" : "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "TagInfos" : [ {
    "TagKey" : "testKey",
    "TagValue" : "testValue",
    "DBInstanceIds" : [ "pxc-xxx" ]
  } ]
}

错误码

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