DescribeAllowLists--RDS for MySQL-Volcengine

Docs

RDS for MySQL

Security encryption

DescribeAllowLists

Call the DescribeAllowLists API to view the allow list.

Request type

Synchronous request.

Request parameters

Name	Type	Required	Example	Description
RegionId	String	No	cn-beijing	Region ID. tip If a region is specified through this parameter, the whitelist list that meets other query conditions in the specified region will be returned. If not specified, the return will be empty. You can call the DescribeRegions interface to query the region information where MySQL instances can be created, including the region ID.
InstanceId	String	No	mysql-h441603c****	The instance ID. When `InstanceId` is specified, the `DescribeAllowLists` API returns the allow lists bound to the specified instance. tip You can call the DescribeDBInstances API to query the basic information of all MySQL instances in the target region, including the instance ID.
QueryDefault	Boolean	No	false	Whether to query only the default allow list. Valid values: `true`: Yes. `false`: No. This is the default value.
IPAddress	String	No	"2.2.2.2,1.1.1.1"	Query the allow list by IP address. Multiple IP addresses are supported, separated by commas (,). tip If the allow list contains any subset of the specified IP addresses, it will be returned.
ProjectName	String	No	default	The project to which the allow list belongs. tip If the AK/SK used to call the API belongs to a sub-account that only has permissions for a specific project, this parameter must be specified.
WithIpList	Boolean	No	true	Whether to return the list of IP addresses and IP address ranges included in the whitelist. Values: `true`: Yes. `false`: No. Default value.

Response parameters

null

Name	Type	Example	Description
AllowLists	Object[]	Refer to the response example.	The list of allow list information.
AllowListCategory	String	Default	Whitelist classification. Values: `Ordinary`: Ordinary whitelist. `Default`: Default whitelist. tip When this parameter is used as a request parameter, the default value is `Ordinary`.
AllowListDesc	String	test	Remarks of the whitelist.
AllowListId	String	acl-d1fd76693bd54e658912e7337d5b****	Whitelist ID.
AllowListName	String	test	The name of the whitelist.
AllowListIPNum	Integer	2	The total number of IP addresses (or address segments) in the whitelist.
AllowListType	String	IPv4	The type of IP address in the whitelist. Currently only IPv4 addresses are supported.
AssociatedInstanceNum	Integer	1	The total number of instances bound under the whitelist.
IpList	String[]	[ "172.*..0/18","192...6","10...1/32","10..*.2/32" ]	The list of IP addresses and IP address ranges included in the whitelist. It is returned when the value of the request parameter WithIpList is `true`, and it is returned as `null` when the value is `false` or when no value is passed for it.
SecurityGroupBindInfos	Object[]	No.	The information of the security group associated with the whitelist.
BindMode	String	AssociateEcsIp	The mode of associating the security group. Values: `IngressDirectionIp`: Inbound IP. `AssociateEcsIp`: Associate ECS IP. tip In the CreateAllowList interface, the BindMode and SecurityGroupId fields of the SecurityGroupBindInfoObject are required.
SecurityGroupId	String	sg-b8pzuwk3i4g028j06k8f****	Security group ID. tip In the CreateAllowList interface, the BindMode and SecurityGroupId fields of the SecurityGroupBindInfoObject are required.
IpList	String[]	["10.*..1/32","10..*.2/32"]	The IP of the security group.
SecurityGroupName	String	Test security group	Security group name. tip In the DescribeAllowLists interface, this field is not returned when SecurityGroupBindInfoObject is used as a return parameter.

Sample request

POST /?Action=DescribeAllowLists&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-h441603c****",
    "RegionId": "cn-beijing",
    "WithIpList": true
}

Sample response

{
    "ResponseMetadata": {
        "RequestId": "2024031919043065E0B28E05E6A2AF458A",
        "Action": "DescribeAllowLists",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "AllowLists": [
            {
                "AllowListCategory": "Default",
                "AllowListDesc": "",
                "AllowListIPNum": 4,
                "AllowListId": "acl-f90a90d96ee7401e912649bee4e2****",
                "AllowListName": "AllowlistName",
                "AllowListType": "IPv4",
                "AssociatedInstanceNum": 8,
                "IpList": [
                    "172.***.***.0/18",
                    "192.***.***.6",
                    "10.***.***.1/32",
                    "10.***.***.2/32"
                ],
                "ProjectName": "default",
                "SecurityGroupBindInfos": [
                    {
                        "BindMode": "IngressDirectionIp",
                        "IpList": [
                            "10.***.***.251/32",
                            "192.***.***.1/32",
                            "192.***.***.0/32",
                            "10..***.***.252/32"
                        ],
                        "SecurityGroupId": "sg-1mwy7b2bd0074j63v426****"
                    }
                ]
            }
        ]
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2026.01.30 11:13:50

RDS for MySQL

Request type #

Request parameters #

Response parameters #

Sample request #