DescribeTagsByResource--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeTagsByResource

最近更新时间：2024.12.05 19:57:08首次发布时间：2023.08.08 20:56:32

调用 DescribeTagsByResource 接口查询目标 Redis 实例已绑定的标签。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceIds	String[]	是	[ "redis-cnlflix66ohil**", "redis-cnlfpoc48rz7g**" ]	需要查询已绑定标签的实例 ID。说明支持一次传入多个实例 ID，多个实例之间用英文逗号（,）分隔。最多同时传入 50 个实例 ID。您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
PageNumber	Integer	是	1	实例标签信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	是	10	每页记录数，取值范围为 1~1000。
TagFilters	Object[]	否		用于查询筛选的标签键值对数组。说明若该参数留空，表示不使用标签条件进行筛选。

返回参数

参数	类型	示例值	描述
Total	Integer	3	符合查询条件的结果总数。
TagResources	Object[]		实例绑定的标签信息。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeTagsByResource&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceIds": [
        "redis-cnlflix66ohil****",
        "redis-cnlfpoc48rz7g****"
    ],
    "TagFilters": [
        {
            "Key": "department",
            "Value": "game"
        },
        {
            "Key": "chargetype",
            "Value": "postpaid"
        }
    ],
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230804155514FE4F49ADA2A620583954",
        "Action": "DescribeTagsByResource",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "TagResources": [
            {
                "InstanceId": "redis-cnlflix66ohil****",
                "Key": "department",
                "Value": "game"
            },
            {
                "InstanceId": "redis-cnlfpoc48rz7g****",
                "Key": "chargetype",
                "Value": "prepaid"
            },
            {
                "InstanceId": "redis-cnlfpoc48rz7g****",
                "Key": "department",
                "Value": "game"
            },
        ],
        "Total": 3
    }
}

错误码

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