Docs

RDS for SQL Server

Allowlist

ModifyAllowList - Modify an allowlist

Call the ModifyAllowList API to modify the allowlist of an instance.

Request parameters

This section describes only the request parameters specific to this API and some common parameters. For more information, refer to Common parameters.

Action string required Example value: ModifyAllowList

The operation to perform. The value is ModifyAllowList.

Version string required Example value: 2022-01-01

The API version is 2022-01-01.

ProjectName string Optional Example value: test

Project name.

AllowListId string required Example value: acl-04908986ad034ac0ba1fb1e3a754****

The allowlist IDs.

AllowListName string required Example value: test

Allowlist name.

AllowListDesc string Optional Example value: Description

The allowlist description.

AllowList string Optional Example value: 10.1.****.****

An IP address or an IP address range in CIDR format.

tip

The AllowList and SecurityGroupBindInfos parameters cannot both be empty.

Do not set duplicate addresses. Separate multiple addresses with a comma (,).

If you set 0.0.0.0/0, it allows access from all addresses, and the 0.0.0.0/0 entry has a higher priority than other network ranges.

Setting the CIDR to 192.168.1.0/24 allows access from IP addresses within that network range; setting 192.168.1.1 allows access from only that IP address.

UserAllowList string Optional Example: 0.0.****.****/0,192.168.****.****/24

The IP addresses outside the security group that need to be added to the allowlist. You can enter an IP address or an IP address range in CIDR format.

tip

If this field is used with the AllowList field, UserAllowList takes precedence.

ModifyMode string Optional Example value: Cover

The modification mode. Valid values:

Cover: Overwrites the original allowlist with the value of the AllowList parameter.

ApplyInstanceNum integer Optional Example value: 2

The number of instances associated with the current allowlist.

This parameter is required when modifying the IP addresses in the allowlist (the AllowList parameter) or its associated security groups (the SecurityGroupBindInfos parameter).

The value for this parameter must match the number of instances currently associated with the allowlist; otherwise, the API call will return an error.

You can call the DescribeAllowLists API to query information about all allowlists in a specified region under the current account, including the total number of associated instances (the value of the AssociatedInstanceNum parameter in the response).

AllowListCategory string Optional Example value: Ordinary

The allowlist category. Possible values:

Ordinary: An ordinary allowlist. Default value.

Default: A default allowlist.

Response parameters

This API has no specific response parameters. For more information, see Response structure.

Request example

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,​
    "SecurityGroupBindInfos": [​
        {​
            "BindMode": "AssociateEcsIp",​
            "IpList": [​
                "172.31.0.4"​
            ],​
            "SecurityGroupId": "sg-3ez4xt2d8vf2872200s******",​
            "SecurityGroupName": "Default"​
        },​
        {​
            "BindMode": "IngressDirectionIp",​
            "IpList": [​
                "192.168.0.0/16"​
            ],​
            "SecurityGroupId": "sg-3f01ez24xury872200******",​
            "SecurityGroupName": "sg-for-vpc-b8pzuqn05yio28j0******"​
        }​
    ],​
    "AllowListCategory": "Default",​
    "UserAllowList": "0.0.****.****/0,192.168.****.****/24"​
}​

Response example

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

Error code

The following table lists the business logic-related error codes for this API. For public error codes, see the Public error codes document.

Status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter %s is not valid.	The value of Parameter {parameter1} is invalid.

Last updated: 2026.01.29 16:48:28