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

文档中心

立即注册

导航

DescribeAllowLists

最近更新时间：2025.06.09 17:22:40首次发布时间：2022.11.23 11:57:58

调用 DescribeAllowLists 接口查询当前账号下指定地域内的所有 IP 白名单信息。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询 HBase 实例所有可用的地域资源信息，包括地域 ID。
InstanceId	String	否	hb-cnglbbb73ea0****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 HBase 实例的基本信息，包括实例 ID。

返回参数

参数	类型	示例值	描述
AllowLists	Array of AllowListInfo	请参见返回示例。	白名单信息列表。

AllowListInfo

参数	类型	示例值	描述
AllowListDesc	String	test	白名单的备注。
AllowListId	String	acl-d1fd76693bd54e658912e7337d5b****	白名单 ID。
AllowListName	String	test	白名单名称。
AllowListIPNum	Long	2	白名单内的 IP 地址（或地址段）总数。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstanceNum	Long	1	白名单下绑定的实例总数。
AllowListCategory	String	Ordinary	白名单分类。取值： `Ordinary`：普通白名单。 `Default`：默认白名单。

示例

请求示例

POST https://hbase.cn-beijing.volcengineapi.com?Action=DescribeAllowLists&Version=2018-01-01 HTTP/1.1
Host: hbase.cn-beijing.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=****
{
    "RegionId": "cn-beijing",
    "InstanceId": "hb-cnglbbb73ea0****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211102158400101742461360830****",
        "Action": "DescribeAllowLists",
        "Version": "2018-01-01",
        "Service": "hbase",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListCategory": "Default",
                "AllowListDesc": "",
                "AllowListIPNum": 2,
                "AllowListId": "acl-4a8ade08756c4433801a91e3a2ee****",
                "AllowListName": "test",
                "AllowListType": "IPv4",
                "AssociatedInstanceNum": 2
            }
        ]
    }
}