Docs

RDS for PostgreSQL

Data security

ModifyAllowList

Call the ModifyAllowList API to modify the allowlist.

Request type

Synchronous request.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Required?	Example	Description
AllowListId	String	Yes	acl-2b7d64502b0a4210a24c58e739de****	Allowlist ID Refer to the DescribeAllowLists API for the query
AllowListName	String	Yes	New allowlist name	Can be the same as the original allowlist name or different. If different, the allowlist will be renamed using the value in the AllowListName field. The naming rules for allowlists are as follows: Within the current region, the allowlist name is unique. Begin with Chinese, a letter, or an underscore (_). It can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-). The name length is limited to 1-128 characters.
AllowListDesc	String	No	This is a new allowlist description.	Description of the allowlist. Length is within 200 characters. tip Default value. If this parameter is not set, the original description information is not modified.
AllowList	String	No	10.1.1.1,10.2.3.0/24	IP address included in the allowlist. Multiple IP addresses are separated by commas (,). IP address cannot be duplicated. The following two formats are supported: IP address format. For example: 10.23.12.24. IP address range in CIDR format. For example: 10.23.12.0/24 (classless inter-domain routing, 24 indicates the prefix length in the address, ranging from 1 to 32). tip Each allowlist can contain up to 300 IPs or CIDR blocks. When there are many IPs, it is recommended to merge them into CIDR blocks, such as 10.23.12.0/24. It is forbidden to add IP addresses, in the form of x.x.x.x/0 other than 0.0.0.0/0, to the allowlist. Default value. If this parameter is not set, the original IPs in the allowlist are not modified.
ModifyMode	String	No	Cover	Modify an allowlist method. Values: Cover: overwrite, which means overwriting the original allowlist with the value of the AllowList field. Default value. Append: append, which means adding the IP addresses contained in the AllowList field to the original allowlists. Delete: delete, which means deleting the IP addresses contained in the AllowList field from the original allowlists. At least one IP address must be retained. warning If the allowlist to be modified is bound to a security group, or if the allowlist needs to be bound to a security group when modifying it, ModifyMode can only be set to Cover.
ApplyInstanceNum	Integer	No	1	The quantity of instances bound to this allowlist, used to confirm the impact scope of this modification and prevent incorrect operations. tip Default value. If no value is passed, it means no confirmation is required for the number of instances affected by modifying the allowlist.
AllowListCategory	String	No	Default	Allowlist category. Values: Ordinary: ordinary allowlist. Default: default allowlist. tip This parameter has no default value when used as a request parameter. If not provided, it queries allowlists of all categories.
SecurityGroupBindInfos	Array of SecurityGroupBindInfo	No	See the request example.	Information about the security group associated with the allowlist.
UpdateSecurityGroup	Boolean	No	true	Whether to update the security group bound to the allowlist. Values: true: update. false: do not update. Default value.
UserAllowList	String	No	10.1.1.1,10.2.3.0/24	The IP address outside the security group that needs to be added to the allowlists. You can enter an IP address or an IP address range in CIDR format.

SecurityGroupBindInfo

Parameter	Type	Required?	Example	Description
IpList	Array of String	No	["10...1/32","10...2/32"]	IP address in the security group.
BindMode	String	Yes	IngressDirectionIp	The mode for associating a security group. Values: IngressDirectionIp: ingress direction IP. AssociateEcsIp: associated ECS IP.
SecurityGroupId	String	Yes	sg-b8pzuwk3i4g028j06k8f****	Security group ID.
SecurityGroupName	String	No	Test security group	Security group name.

Response parameters

null

Sample

Sample request

POST /?Action=ModifyAllowList&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-postgresql.cn-beijing.volcengineapi.com​
X-Date: 20231002T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/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"​
}​

Sample response

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

Last updated: 2026.03.31 10:45:19