PolarDB Cluster Access Control via IP Whitelists & Security Groups - PolarDB - Alibaba Cloud - PolarDB

Queries the IP whitelist and security groups that are allowed to access a database cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	pc-***************

Response elements

Element	Type	Description	Example
	object
DBClusterSecurityGroups	object
DBClusterSecurityGroup	array<object>	The list of ECS security groups associated with the cluster.
	object
SecurityGroupId	string	The ID of the ECS security group.	sg-bp**************
SecurityGroupName	string	The name of the ECS security group.	vpc-********************
Items	object
DBClusterIPArray	array<object>	The list of IP whitelist groups for the cluster.
	object
DBClusterIPArrayAttribute	string	The attributes of the IP whitelist group. Set this parameter to hidden to hide the IP whitelist group in the console. Note The IP whitelist group that has appeared in the console cannot be hidden. This parameter can be specified only when the WhiteListType parameter is set to IP.	hidden
DBClusterIPArrayName	string	The name of the IP whitelist group. The group name must be 2 to 120 characters in length and consists of lowercase letters and digits. It must start with a letter, and end with a letter or a digit. If the specified whitelist group name does not exist, the whitelist group is created. If the specified whitelist group name exists, the whitelist group is modified. If you do not specify this parameter, the default group is modified. Note You can create a maximum of 50 IP whitelist groups for a cluster. This parameter can be specified only when the WhiteListType parameter is set to IP.	default
SecurityIps	string	The IP addresses or Classless Inter-Domain Routing (CIDR) blocks in the IP whitelist group. You can add 1,000 IP addresses or CIDR blocks to all the IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported: IP addresses. Example: 10.23.12.24. CIDR blocks. Example: 10.23.12.24/24. 24 indicates the length of the prefix of the CIDR block. The length is the range of 1 to 32. Note This parameter can be specified only when the WhiteListType parameter is set to IP.	11.*..,11...*
RequestId	string	The request ID.	559E91A2-CDA3-4E9F-808B-29D738******

Examples

Success response

JSON format

{
  "DBClusterSecurityGroups": {
    "DBClusterSecurityGroup": [
      {
        "SecurityGroupId": "sg-bp**************",
        "SecurityGroupName": "vpc-********************"
      }
    ]
  },
  "Items": {
    "DBClusterIPArray": [
      {
        "DBClusterIPArrayAttribute": "hidden",
        "DBClusterIPArrayName": "default",
        "SecurityIps": "11.***.***.***,11.***.***.***"
      }
    ]
  },
  "RequestId": "559E91A2-CDA3-4E9F-808B-29D738******"
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API does not support RAM.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.