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

DescribeTagsByResource

最近更新时间：2023.08.28 14:46:12

首次发布时间：2023.08.08 20:56:32

我的收藏

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

请求类型

同步请求。

请求参数

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

InstanceIds

Array of String

是

[
"redis-cnlflix66ohil****",
"redis-cnlfpoc48rz7g****"
]

需要查询已绑定标签的实例 ID。

说明

  • 支持一次传入多个实例 ID，多个实例之间用英文逗号（,）分隔。最多同时传入 50 个实例 ID。
  • 您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

TagFilters

Array of TagFilterInfo

否

[
{
"Key":"instancetype",
"Value":"cluster"
},
{
"Key":"chargetype",
"Value":"postpaid"
}
]

用于查询筛选的标签键值对数组。

说明

  • 当需要使用标签对查询结果进行筛选时，标签键（Key）必填，标签值（Value）可不填，不填标签值表示不对标签值作限制，会搜索所有绑定了指定标签键的实例。关于 TagFilters 的更多说明，请参见数据结构。
  • 单次最多支持同时传入 10 组标签键值对进行查询筛选。
PageSizeInteger是10每页记录数，取值范围为 1~1000。
PageNumberInteger是1实例标签信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。

返回数据

名称类型示例值描述
TotalInteger3符合查询条件的结果总数。
TagResourcesArray of TagResourceInfo请参见返回示例。实例绑定的标签信息。关于 TagResources 的更多说明，请参见数据结构。

请求示例

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":"instancetype",
            "Value":"cluster"
        },
        {
            "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": "chargetype",
                "Value": "prepaid"
            },
            {
                "InstanceId": "redis-cnlfpoc48rz7g****",
                "Key": "chargetype",
                "Value": "prepaid"
            },
            {
                "InstanceId": "redis-cnlfpoc48rz7g****",
                "Key": "instancetype",
                "Value": "cluster"
            },
        ],
        "Total": 3
    }
}

错误码

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