DescribeTagsByResource--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeTagsByResource

最近更新时间：2024.11.05 16:00:07首次发布时间：2023.08.14 13:15:55

调用 DescribeTagsByResource 接口查询一个或多个 MySQL 实例的标签。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceIds	String[]	是	["mysql-46609cf2**","mysql-5564bc65**"]	实例 ID。
TagFilters	Object[]	否	请参见请求示例。	用于查询筛选的标签键值对数组。说明单次最多支持同时传入 10 组标签键值对进行查询筛选。
PageNumber	Integer	是	1	当前页页码。取值最小为 1。默认值为 1。
PageSize	Integer	是	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。

返回参数

参数	类型	示例值	描述
Total	Integer	2	标签总数。
TagResources	Object[]	请参见返回示例。	实例的标签列表。

示例

请求示例

POST /?Action=DescribeTagsByResource&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceIds": [
        "mysql-46609cf2****",
        "mysql-5564bc65****"
    ],
    "TagFilters": [
        {
            "Key": "test1"
        }
    ],
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308091903447828DBC85919F18E0646",
        "Action": "DescribeTagsByResource",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "TagResources": [
            {
                "InstanceId": "mysql-46609cf2****",
                "Key": "test1",
                "Value": "123"
            },
            {
                "InstanceId": "mysql-5564bc65****",
                "Key": "test1",
                "Value": "123"
            }
        ],
        "Total": 2
    }
}

错误码

更多详情，请参见错误码。