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

文档中心

立即注册

导航

ModifyAllowList

最近更新时间：2024.11.08 10:14:36首次发布时间：2022.08.20 16:54:39

调用 ModifyAllowList 接口修改目标白名单设置，例如白名单名称、IP 白名单地址等。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
AllowListId	String	是	acl-04908986ad034ac0ba1fb1e3a754****	白名单 ID。说明您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单 ID。
AllowListName	String	是	test	白名单名称。如需修改白名单名称，此参数应指定为新的白名单名称。名称需满足以下要求：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需在 1～128 个字符内。无需修改白名单名称时，此参数指定为原白名单的名称即可。您可以调用 DescribeAllowLists 接口查询指定地域下所有的白名单列表信息，包括白名单名称。
ApplyInstanceNum	Integer	否	1	白名单所绑定的实例个数。说明此参数用于确认本次修改的影响范围，避免误操作引发故障。当指定 AllowList 参数时，该参数必填，参数值为已绑定该白名单的实例总数。您可以调用 DescribeAllowLists 接口查询指定地域下白名单绑定的实例总数。
AllowList	String	否	192.168.1.0	输入 IP 地址或 CIDR 格式的 IP 地址段。说明当需要变更白名单中的 IP 地址时，该参数必填。当需要指定 ApplyInstanceNum 参数时，此参数为必填。每个白名单中最多支持设置 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 地址访问。
ModifyMode	String	否	Cover	修改白名单的方式，支持设置为： `Cover`（默认）：使用 AllowList 参数中的值覆盖原白名单。 `Append`：在原白名单中增加 AllowList 参数中输入的 IP 地址。 `Delete`：在原白名单中删除 AllowList 参数中输入的 IP 地址。至少需要保留一个 IP 地址。
AllowListDesc	String	否	test	白名单的备注信息，长度不可超过 200 个字符。

返回参数

null

请求示例

POST /?Action=ModifyAllowList&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****

{
    "AllowListId": "acl-04908986ad034ac0ba1fb1e3a754****",
    "AllowListName": "test",
    "AllowList": "192.168.1.0",
    "ApplyInstanceNum":1
}

返回示例

正常返回示例

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

错误码

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