You need to enable JavaScript to run this app.
导航
云数据库 PostgreSQL 版
  • 文档首页
    • /
  • 云数据库 PostgreSQL 版

ModifyAllowList

最近更新时间：2024.05.06 17:28:10

首次发布时间：2024.04.28 11:36:22

我的收藏

调用 ModifyAllowList 接口修改白名单。

请求类型

同步接口。

请求参数

参数类型是否必填示例描述
AllowListIdString是acl-2b7d64502b0a4210a24c58e739de****白名单的 ID。可调用 DescribeAllowLists 接口查询。

AllowListName

String

是

新的白名单名称

可与原白名单名字相同，也可以不相同。不相同时，会以 AllowListName 字段的值为白名单重新命名。白名单名称的命名规则如下：

  • 在当前地域内，白名单名称唯一。

  • 以中文、字母或下划线（_）开头。

  • 只能包含中文、字母、数字、下划线（_）和中划线（-）。

  • 长度为 1~128 个字符。

AllowListDescString否这是一段新的白名单描述信息。白名单的描述信息。长度在 200 字符以内。

AllowList

String

否

10.1.1.1,10.2.3.0/24

白名单中包含的 IP 地址。多个 IP 地址间以英文逗号（,）分隔。IP 地址不可重复。支持以下两种格式：

  • IP 地址格式。例如：10.23.12.24。

  • CIDR 的 IP 地址段格式。例如：10.23.12.0/24（无类别域间路由，24 表示了地址中前缀的长度，范围为 1~32）。

说明

  • 每个白名单最多可添加 300 个 IP 或 IP 地址段，当 IP 较多时，建议合并为IP段填入，例如10.23.12.0/24。
  • 禁止将 0.0.0.0/0 之外的形如 x.x.x.x/0 的 IP 地址加入白名单。

ModifyMode

String

否

Cover

修改白名单的方式。取值：

  • Cover：默认值。覆盖，即使用 AllowList 字段的值覆盖原白名单。
  • Append：追加，即在原白名单中增加 AllowList 字段包含的 IP 地址。
  • Delete：删除，即在原白名单中删除 AllowList 字段包含的 IP 地址。至少需要保留一个 IP 地址。

ApplyInstanceNum

Number

否

1

绑定了该白名单的实例数量。用于确认本次修改的影响范围，避免误操作。

返回参数

null

请求示例

POST /?Action=ModifyAllowList&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-guangzhou/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
        "AllowListId":"acl-2b7d64502b0a4210a24c58e739de****",
        "AllowList": "10.1.1.1,10.2.3.0/23",
        "AllowListDesc":"这是一段新的白名单描述信息。",
        "AllowListName": "新的白名单名称",
        "AllowListType": "IPv4",
        "ModifyMode":"Cover"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240423192049E80D10ED81E54EDC1083-5373b8",
        "Action": "ModifyAllowList",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-guangzhou"
    },
    "Result": null
}