文档中心

云数据库 SQL Server 版

白名单管理

ModifyAllowList - 修改白名单

调用 ModifyAllowList 接口修改实例的白名单。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ModifyAllowList

要执行的操作，取值：ModifyAllowList。

Version string 必选示例值：2022-01-01

API 的版本，取值：2022-01-01。

ProjectName string 可选示例值：test

项目名称。

AllowListId string 必选示例值：acl-04908986ad034ac0ba1fb1e3a754****

白名单 ID。

AllowListName string 必选示例值：test

白名单名称。

AllowListDesc string 可选示例值：描述

白名单描述。

AllowList string 可选示例值：10.1.****.****

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

说明

不允许设置重复的地址，多个地址间用英文逗号（,）隔开。

如果设置 0.0.0.0/0，表示允许所有地址访问，且 0.0.0.0/0 字段的优先级高于其他网段。

设置 CIDR 192.168.1.0/24，表示允许该网段内的 IP 地址访问；设置 192.168.1.1，表示仅允许该 IP 地址访问。

UserAllowList string 可选示例值：0.0.****.****/0,192.168.****.****/24

安全组之外的、需要加入白名单的 IP 地址。可输入 IP 地址或 CIDR 格式的 IP 地址段。

说明

若该字段与 AllowList 字段同时使用，则以该字段 UserAllowList 为准。

ModifyMode string 可选示例值：Cover

修改方式，取值如下：

Cover：表示使用 AllowList 参数的值覆盖原白名单。

ApplyInstanceNum integer 可选示例值：2

当前白名单所绑定的实例个数。

当需要修改白名单的 IP（即 AllowList）信息时，该参数必填。

该参数传入的值必须与当前白名单所绑定的实例个数一致，否则调用该接口时会报错。

您可以调用 DescribeAllowLists 接口查询当前账号下在指定地域内的所有白名单列表信息，包括白名单下绑定的实例总数（即返回参数中 AssociatedInstanceNum 的参数值）。

AllowListCategory string 可选示例值：Ordinary

白名单分类。取值：

Ordinary：普通白名单。默认值。

Default：默认白名单

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=ModifyAllowList&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mssql.cn-beijing.volcengineapi.com​
X-Date: 20230131T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
​
{​
    "AllowListId": "acl-ba7e0e2ab5f04a9f94dc397a9a******",​
    "AllowListName": "test",​
    "AllowListDesc": "test",​
    "AllowList": "0.0.****.****/0,192.168.****.****/24",​
    "ApplyInstanceNum": 0,​
    "AllowListCategory": "Default",​
    "UserAllowList": "0.0.****.****/0,192.168.****.****/24"​
}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20251117170520211075046087E62647",​
    "Action": "ModifyAllowList",​
    "Version": "2022-01-01",​
    "Service": "rds_mssql",​
    "Region": "cn-beijing"​
  },​
  "Result": null​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is not valid.	参数 {parameter1} 值无效。

最近更新时间：2026.02.09 16:41:39

这个页面对您有帮助吗？

有用

无用