DescribeTagsByResource--表格数据库 HBase 版-火山引擎

文档中心

立即注册

导航

DescribeTagsByResource

最近更新时间：2024.06.25 10:03:51首次发布时间：2023.10.08 16:15:39

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

请求类型

同步请求。

请求参数

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

返回参数

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

示例

请求示例

POST https://hbase.volcengineapi.com?Action=DescribeTagsByResource&Version=2018-01-01 HTTP/1.1
Host: hbase.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/hbase/request,SignedHeaders=content-type;host;x-date,  Signature=****
{
    "InstanceIds": [
        "hb-cncqbedcce3c****",
        "hb-cncqbedcce3c****"
    ],
    "TagFilters": [
        {
            "Key": "instancetype",
            "Value": "cluster"
        },
        {
            "Key": "chargetype",
            "Value": "postpaid"
        }
    ],
    "PageNumber": 1,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023082814520678680D04B5DBAC619DF5",
        "Action": "DescribeTagsByResource",
        "Version": "2018-01-01",
        "Service": "hbase",
        "Region": "cn-beijing"
    },
    "Result": {
        "TagResources": [
            {
                "InstanceId": "hb-cncq335e3f13****",
                "Key": "chargetype",
                "Value": "prepaid"
            },
            {
                "InstanceId": "hb-cncq335e3f13****",
                "Key": "instancetype",
                "Value": "cluster"
            }
        ],
        "Total": 2
    }
}