You need to enable JavaScript to run this app.
导航
CreateAllowList
最近更新时间:2024.06.13 14:27:25首次发布时间:2022.08.20 16:54:39

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

请求类型

同步请求。

请求参数

名称类型是否必选示例值描述

AllowListName

String

test

白名单名称。名称需满足以下要求:

  • 不能以数字、中划线(-)开头。
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。
  • 长度需在 1~128 个字符内。

AllowList

String

127.0.0.1

输入 IP 地址或 CIDR 格式的 IP 地址段。

说明

每个白名单分组中最多支持设置 300 个 IP 地址或 CIDR 格式的 IP 地址段。不允许设置重复的地址,多个地址间用英文逗号(,)隔开。特殊示例如下所示:

  • 设置 0.0.0.0/0,表示允许所有地址访问。
  • 设置 127.0.0.1,表示禁止所有地址访问。
  • 同时设置 0.0.0.0/0127.0.0.1,表示允许所有地址访问。
  • 设置 192.168.1.1,表示仅允许该 IP 地址访问。
  • 设置 CIDR 192.168.1.0/24,表示允许该网段内的 IP 地址访问。
AllowListDescStringtest白名单的备注信息,长度不可超过 200 个字符。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持指定为 IPv4,表示 IPv4 地址。

返回参数

名称类型示例值描述
AllowListIdStringacl-d1fd76693bd54e658912e7337d5b****白名单 ID。

请求示例

POST /?Action=CreateAllowList&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKIAIAGMBG4SXSQQ****/20220614/cn-beijing/veDB/request, SignedHeaders=accept;content-type;host;x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****

{
    "AllowListName":"test",
    "AllowList": "127.0.0.1",
    "AllowListDesc":"test",
    "AllowListType": "IPv4"
}

返回示例

正常返回示例

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

错误码

更多详情,请参见错误码