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

文档中心

导航

CreateAllowList

最近更新时间：2024.08.15 16:56:56首次发布时间：2023.02.02 17:41:21

调用 CreateAllowList 接口创建白名单。

使用限制

该接口支持通过绑定安全组或输入 IP 创建白名单，应至少选择其中一种方式或两种方式可同时进行。在绑定安全组创建的方式下，可使用 SecurityGroupIds 或 SecurityGroupBindInfos 字段，这两个字段不能同时使用；在输入 IP 创建的方式下，可使用 AllowList 或 UserAllowList 字段，这两个字段不能同时使用。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
AllowListName	String	是	test	白名单名称，名称需同时满足如下要求：不能以数字或中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~128 个字符。
AllowListDesc	String	否	test	白名单的备注信息，长度不可超过 200 个字符。
AllowListType	String	否	IPv4	白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AllowList	String	否	10.1.1.1,10.2.3.0/24	输入 IP 地址或 CIDR 格式的 IP 地址段。说明每个白名单分组中最多支持设置 300 个 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 地址访问。该字段与 SecurityGroupIds 二者必选其一。
SecurityGroupIds	Array of String	否	["sg-13fuw9bo2hlhc3n6nu4g****"]	需要关联的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。该字段不能与 SecurityGroupBindInfos 同时使用。该字段与 AllowList 或 UserAllowList 二者必选其一。
SecurityGroupBindInfos	Array of SecurityGroupBindInfoObject	否	请参见请求示例。	白名单关联的安全组的信息。关于 SecurityGroupBindInfoObject 的更多信息，请参见数据结构。说明在 CreateAllowList 接口中，SecurityGroupBindInfoObject 的 BindMode 和 SecurityGroupId 字段为必填项。
AllowListCategory	String	否	Default	白名单分类。取值： `Ordinary`：普通白名单。默认值。 `Default`：默认白名单。
UserAllowList	String	否	10.*..,10..**.0/24	安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段与 AllowList 不能同时使用。

返回参数

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

请求示例

POST /?Action=CreateAllowList&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKIAIAGMBG4SXSQQ****/20220614/cn-beijing/rds_mysql/request, SignedHeaders=accept;content-type;host;x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****
{
    "AllowListName":"test1234",
    "AllowList": "10.1.1.1,10.2.3.0/24",
    "SecurityGroupIds":["sg-13fuw9bo2hlhc3n6nu4g****"]
}

返回示例

正常返回示例

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

错误码

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