You need to enable JavaScript to run this app.
RDS for PostgreSQL

RDS for PostgreSQL

Copy page
Download PDF
Data security
DescribeAllowListDetail
Copy page
Download PDF
DescribeAllowListDetail
Call the DescribeAllowListDetail API to query the allowlist details.​
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.
​
Request parameters​
​
Parameter​
Type​
Required?​
Example​
Description​
AllowListId​
String​
Yes​
acl-fe1339b0024e42ca9872e8f4af12****​
Allowlist ID​
​
Response parameter​
​
Parameter​
Type​
Example​
Description​
AllowListId​
String​
acl-fe1339b0024e42ca9872e8f4af12****​
Allowlist ID​
AllowListName​
String​
Test allowlists​
Name of the allowlists.​
AllowListDesc​
String​
This is a description of an allowlist.​
Description of the allowlist.​
AllowListType​
String​
IPv4​
Network protocol type used by the allowlist. Value is IPv4.​
AllowList​
String​
10.1.1.1,10.2.2.0/24​
List of IP addresses or CIDR blocks in the allowlists.​
AllowListCategory​
String​
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.​
AssociatedInstanceNum​
Long​
8​
Number of instances bound to the allowlist.​
AssociatedInstances​
Refer to the Sample response.​
The allowlists-associated instances list includes instance ID and instance name information.​
SecurityGroupBindInfos​
Refer to the sample response.​
List of security groups bound to this allowlist.​
UserAllowList​
String​
10.1.1.1,10.2.3.0/24​
IP address added to the allowlists outside the security group.​
​
AssociatedInstanceObject​
​
Parameter​
Type​
Example​
Description​
InstanceId​
String​
postgres-e49268e4****​
Instance ID.​
InstanceName​
String​
This is an instance name​
Name of the instance.​
VPC​
String​
vpc-b81xq5qk9wjk28j06k3l****​
The ID of the instance's virtual private cloud.​
​
SecurityGroupBindInfo​
​
Parameter​
Type​
Example​
Description​
IpList​
Array of String​
["10...1/32","10...2/32"]​
IP address in the security group.​
BindMode​
String​
IngressDirectionIp​
The mode for associating a security group. Values:​
  • IngressDirectionIp: ingress direction IP.​
  • AssociateEcsIp: associated ECS IP.​
SecurityGroupId​
String​
sg-b8pzuwk3i4g028j06k8f****​
Security group ID.​
SecurityGroupName​
String​
Test security group​
Security group name.​
​
Example​
Sample request​
​
POST /?Action=DescribeAllowListDetail&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-fe1339b0024e42ca9872e8f4af12****"​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "202507171609269A59EE64CB5BAB44E8A6-33e3b7",​
"Action": "DescribeAllowListDetail",​
"Version": "2022-01-01",​
"Service": "rds_postgresql",​
"Region": "cn-beijing"​
},​
"Result": {​
"AllowList": "1.***.***.1,192.***.***.40,192.***.***.108,192.16***8.***.3",​
"AllowListCategory": "Ordinary",​
"AllowListDesc": "",​
"AllowListId": "acl-9a5faa2306a945b69fea4a65f31f****",​
"AllowListName": "test_allowlist",​
"AllowListType": "IPv4",​
"AssociatedInstanceNum": 8,​
"AssociatedInstances": [​
{​
"InstanceId": "postgres-f006d308****",​
"InstanceName": "测试实例",​
"VPC": "vpc-2gdku6nvnp1xc50ztz0py****"​
}​
],​
"SecurityGroupBindInfos": [​
{​
"BindMode": "AssociateEcsIp",​
"SecurityGroupId": "sg-2gdgzrxi8uigw50ztz0e9****"​
},​
{​
"BindMode": "AssociateEcsIp",​
"IpList": [​
"192.***.***.40",​
"192.***.***.108",​
"192.***.***.3"​
],​
"SecurityGroupId": "sg-2gdku6tsr17uo50ztyz9h****"​
},​
{​
"BindMode": "AssociateEcsIp",​
"SecurityGroupId": "sg-30ud5qcwpx6v47r2qr1kl****"​
}​
],​
"UserAllowList": "1.***.***.1"​
}​
}​
​
Last updated: 2026.03.31 10:45:19