CreateAllowList--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

CreateAllowList

最近更新时间：2025.08.25 20:25:19首次发布时间：2024.04.28 11:36:22

调用 CreateAllowList 接口创建白名单。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
AllowListName	String	是	测试白名单	白名单名称的命名规则如下：在当前地域内，白名单名称唯一。以中文、字母或下划线（_）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度为 1~128 个字符。
AllowListDesc	String	否	这是一个测试白名单	白名单的描述信息。长度在 200 字符以内。默认值为空字符串。
AllowListType	String	否	IPv4	白名单采用的网络协议类型。取值为 `IPv4`（默认值）。
AllowList	String	否	10.1.1.1,10.2.3.0/24	白名单中包含的 IP 地址。多个 IP 地址间以英文逗号（,）分隔。IP 地址不可重复。支持以下两种格式： IP 地址格式。例如：`10.23.12.24`。 CIDR 的 IP 地址段格式。例如：`10.23.12.0/24`（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。说明每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为 IP 段填入，例如10.23.12.0/24。禁止将 `0.0.0.0/0` 之外的形如 `x.x.x.x/0` 结尾的 IP 地址加入白名单。该字段不能与 UserAllowList 字段同时使用。
AllowListCategory	String	否	Default	白名单分类。取值： `Ordinary`：普通白名单。 `Default`：默认白名单。说明该参数作为请求参数时无默认值，不传入时则查询所有类别的白名单。
SecurityGroupBindInfos	Object[]	否	请参见请求示例。	需要为白名单绑定的安全组的信息。
UserAllowList	String	否	10.1.1.1,10.2.3.0/24	安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段不能与 AllowList 字段同时使用。

返回参数

参数	类型	示例值	描述
AllowListId	String	acl-2b7d64502b0a4210a24c58e739de****	白名单的 ID。

示例

请求示例

POST /?Action=CreateAllowList&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "AllowListDesc": "这是一个测试白名单",
    "AllowListName": "测试白名单",
    "AllowList": "10.1.1.1,10.2.3.0/24",
    "SecurityGroupIds": [
        "sg-13fuw9bo2hlhc3n6nu4g****"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024042319123272910D61D1EA53CF50B2-0a580d",
        "Action": "CreateAllowList",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "AllowListId": "acl-2b7d64502b0a4210a24c58e739de****"
    }
}