DescribeDBClusterAccessWhitelist - PolarDB - Alibaba Cloud Documentation Center

Queries the IP address whitelists and security groups configured for 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeDBClusterAccessWhitelist

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
DBClusterSecurityGroups	object
DBClusterSecurityGroup	array<object>	A 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>	A list of IP address whitelist groups for the cluster.
	object
DBClusterIPArrayAttribute	string	The attribute of the IP address whitelist group.	hidden
DBClusterIPArrayName	string	The name of the IP address whitelist group.	default
SecurityIps	string	The list of IP addresses in the IP address whitelist group. The list can contain up to 1,000 IP addresses, separated by commas (,). The following formats are supported: IP address, such as 10.xx.xx.24. CIDR block, such as 10.xx.xx.24/24. The number after the slash (/) indicates the prefix length. The prefix length ranges from 1 to 32.	11.*..,11...*
RequestId	string	The ID of the request.	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 response

JSON format

{
    "Items":{
        "DBClusterIPArray":[
            {
                "DBClusterIPArrayAttribute":"",
                "DBClusterIPArrayName":"default",
                "SecurityIPList":"127.0.0.1"
            },
            {
                "DBClusterIPArrayAttribute":"hidden",
                "DBClusterIPArrayName":"maxscale",
                "SecurityIPList":"11.xx.xx.xx,11.xx.xx.201"
            }
        ]
    },
    "RequestId":"8D0429EC-8E2C-4675-8102-28AC6FE92751"
}

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.