You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

DescribeTagsByResource

最近更新时间：2024.03.06 16:16:32

首次发布时间：2023.08.14 13:15:55

我的收藏

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

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdsArray of String是["mysql-46609cf2****","mysql-5564bc65****"]实例 ID。

TagFilters

Array of TagFilterObject

否

请参见请求示例。

用于查询筛选的标签键值对数组。关于 TagFilters 的更多详情，请参见数据结构。

说明

单次最多支持同时传入 10 组标签键值对进行查询筛选。

PageNumberInteger是1当前页页码。取值最小为 1。默认值为 1。
PageSizeInteger是10每页记录数。最小值为 1，最大值不超过 100。默认值为 10。

返回参数

名称类型示例值描述
TotalInteger2标签总数。
TagResourcesArray of TagResourceObject请参见返回示例。实例的标签列表。关于 TagResources 的更多详情，请参见数据结构。

请求示例

POST /?Action=DescribeTagsByResource&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20230810T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20230810/cn-beijing/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "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
    }
}

错误码

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