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

文档中心

立即注册

导航

ModifyAllowList

最近更新时间：2024.09.06 15:07:18首次发布时间：2023.02.02 17:41:21

调用 ModifyAllowList 接口修改白名单。

使用限制

该接口支持通过绑定安全组或输入 IP 修改白名单，两种方式可同时进行。在绑定安全组创建的方式下，可使用 SecurityGroupIds 或 SecurityGroupBindInfos 字段，这两个字段不能同时使用；在输入 IP 创建的方式下，可使用 AllowList 或 UserAllowList 字段，这两个字段不能同时使用。
如果通过该接口修改白名单绑定的安全组，只能采用覆盖的修改方式，即请求参数 ModifyMode 取值为 Cover。如果在修改白名单绑定的安全组的同时需要修改白名单的 IP，需要注意覆盖的修改方式对 IP 的影响。

请求类型

异步请求。

请求参数

名称	类型	是否必选	示例值	描述
AllowListId	String	是	acl-04908986ad034ac0ba1fb1e3a754****	白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。
AllowListName	String	是	test	白名单名称。说明若需修改原白名单的 IP 地址，直接输入原白名单的名称即可。您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单名称。若需修改白名单名称，直接输入新的白名单名称即可。名称需同时满足如下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需为 1~32 个字符。
ModifyMode	String	否	Cover	修改方式，取值范围如下： `Cover`（默认值）：使用 `AllowList` 参数中的值覆盖原白名单。 `Append`：在原白名单中增加 `AllowList` 参数中输入的 IP 地址。 `Delete`：在原白名单中删除 `AllowList` 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
AllowListDesc	String	否	test	白名单的备注信息，长度不可超过 200 个字符。
AllowList	String	否	192.168.0.1	安全组之外的、需要加入白名单的 IP 地址。可输入 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 地址访问。该字段与 UserAllowList 不能同时使用。
ApplyInstanceNum	Integer	否	1	当前白名单所绑定的实例个数。说明当需要修改 AllowList 参数或 UserAllowList 参数时，该参数必填。您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单下绑定的实例总数。
SecurityGroupIds	Array of String	否	["sg-13fuw9bo2hlhc3n6nu4g****"]	需要修改的安全组 ID 列表。说明您可以调用 DescribeSecurityGroups 接口查询安全组信息，包括安全组 ID。单个白名单单次最多可选择添加 10 个安全组。
SecurityGroupBindInfos	Array of SecurityGroupBindInfoObject	否	请参见请求示例。	白名单关联的安全组的信息。关于 SecurityGroupBindInfoObject 的更多信息，请参见数据结构。
AllowListCategory	String	否	Default	白名单分类。取值： `Ordinary`：普通白名单。默认值。 `Default`：默认白名单。
UserAllowList	String	否	10.1.1.1,10.2.3.0/24	安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。说明该字段与 AllowList 不能同时使用。
UpdateSecurityGroup	Boolean	否	true	是否更新白名单所绑定的安全组。 `true`：更新。 `false`：不更新。默认值。说明该字段仅在白名单已绑定了安全组时生效。可调用 DescribeAllowLists 接口查询白名单是否绑定了安全组。

返回参数

null

请求示例

POST /?Action=ModifyAllowList&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20180614T114308Z
Authorization: HMAC-SHA256 Credential=AKIAIAGMBG4SXSQQ****/20180614/cn-beijing/rds_mysql/request, SignedHeaders=accept;content-type;host;x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****
{
    "AllowListId":"acl-63f61303c8ca430ebffb4eccd12d****",
    "AllowListName":"test1234",
    "AllowList": "10.1.1.1,10.2.3.0/24",
    "ModifyMode":"Append",
    "ApplyInstanceNum":0,
    "SecurityGroupIds":["sg-mjhwycciqgow5smt1bp6****","sg-rr01k8rpkh6ov0x57uk****"]
}

返回示例

正常返回示例

{
     "ResponseMetadata": {
          "RequestId": "2022031913012601022509900809B3****",
          "Action": "ModifyAllowList",
          "Version": "2022-01-01",
          "Service": "rds_mysql",
          "Region": "cn-beijing"
     },
     "Result": null
}

错误码

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