CreateAllowList--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

CreateAllowList

最近更新时间：2024.12.12 21:46:13首次发布时间：2022.04.12 11:06:53

调用 CreateAllowList 接口创建一个新的 IP 白名单。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
AllowListName	String	是	test	白名单名称，名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
AllowList	String	是	10.1.1.1,10.2.3.0/24	输入 IP 地址或 CIDR 格式的 IP 地址段。说明每个白名单分组中最多支持设置 1000 个 IP 地址或 CIDR 格式的 IP 地址段。不允许设置重复的地址，多个地址间用英文逗号（,）隔开。设置 `0.0.0.0/0`，表示允许所有地址访问。设置 `127.0.0.1`，表示禁止所有地址访问。同时设置 `0.0.0.0/0` 和 `127.0.0.1`，表示允许所有地址访问。设置 CIDR `192.168.1.0/24`，表示允许该网段内的 IP 地址访问。设置 `192.168.1.1`，表示仅允许该 IP 地址访问。
AllowListDesc	String	否	test	白名单的备注信息，长度不可超过 200 个字符。说明若不设置该参数，新建白名单的备注信息默认为空。
AllowListType	String	否	IPv4	白名单内的 IP 地址类型。当前仅支持 `IPv4` 地址。
ProjectName	String	否	default	设置白名单所属的项目。项目是一个虚拟的概念，包括一组资源、用户和角色。通过项目可以对一组资源进行统一的查看和管理，并且控制项目内用户和角色对这些资源的权限。更多详情，请参见资源管理。说明若不设置该参数，新建白名单会默认加入 default 项目。

返回参数

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

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=CreateAllowList&Version=2022-01-01 HTTP/1.1
Host: mongodb.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "AllowListName": "test",
    "AllowList": "10.1.1.1,10.2.3.0/24"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220316143231010225099008069A****",
        "Action": "CreateAllowList",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowListId": "acl-d1fd76693bd54e658912e7337d5b****"
    }
}

错误码

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