文档中心

云数据库 veDB MySQL 版

安全

DescribeAllowLists - 获取白名单列表

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

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询可创建实例的地域信息，包括地域 ID。
InstanceId	String	否	vedbm-ca12cbqv****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有实例的基本信息，包括实例 ID。
ProjectName	String	否	default	白名单所属的项目名称。

返回参数

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

AllowListInfo

参数	类型	示例值	描述
AllowListId	String	acl-31f52387922a40a7a60ff21365f6****	白名单 ID。
AllowListName	String	byte****	白名单名称。
AllowListDesc	String	test	白名单的备注。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持指定为 IPv4，表示 IPv4 地址。
AllowListIPNum	Long	3	包含 IP 或 IP 段的总数量。
AssociatedInstanceNum	Long	0	绑定的全部实例数量。
ProjectName	String	default	白名单所属的项目名称。

示例

请求示例

POST /?Action=DescribeAllowLists&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host:vedbm.cn-beijing.volcengineapi.com​
X-Date: 20220101T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****​
{​
    "RegionId": "cn-beijing",​
    "InstanceId": "vedbm-ca12cbqv****"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20220316143231010225099008069A****",​
        "Action": "DescribeAllowLists",​
        "Version": "2022-01-01",​
        "Service": "vedbm",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "AllowLists": [​
            {​
                "AllowListDesc": "test",​
                "AllowListId": "acl-d1fd76693bd54e658912e7337d5b****",​
                "AllowListName": "test",​
                "AllowListIPNum": 2,​
                "AllowListType": "IPv4",​
                "AssociatedInstanceNum": 1,​
                "ProjectName": "default"​
            }​
        ]​
    }​
}​

错误码

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

最近更新时间：2026.07.31 10:06:26

这个页面对您有帮助吗？

有用

无用