ModifyDBClusterAccessWhiteList - Modify IP whitelist - AnalyticDB for MySQL - AnalyticDB

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

adb:ModifyDBClusterAccessWhiteList

update

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	rm-uf6wjk5xxxxxxxxxx
SecurityIps	string	Yes	The IP addresses to add to or modify in the whitelist. Separate multiple IP addresses with commas (,). Maximum: 500. Supported formats: IP address. Example: 10.23.12.24. CIDR block. Example: 10.23.12.24/24. Prefix length: 1 to 32. Note Required unless ModifyMode is set to Delete.	10.23.12.24
DBClusterIPArrayName	string	No	The whitelist name. Default value: Default. Length: 2 to 32 characters. Allowed characters: lowercase letters, digits, and underscores (_). Must start with a lowercase letter and end with a lowercase letter or digit. Maximum: 50 whitelists per cluster.	test
DBClusterIPArrayAttribute	string	No	The whitelist attribute. Empty by default. The hidden attribute hides the whitelist from the console. Used by services such as DTS and PolarDB-X.	hidden
ModifyMode	string	No	The whitelist modification method. Valid values: Cover: overwrites the entire whitelist. Append: adds IP addresses to the whitelist. Delete: removes IP addresses from the whitelist. Default value: Cover.	Cover

Response elements

Element	Type	Description	Example
	object
TaskId	integer	The task ID.	1564657730
RequestId	string	The request ID.	D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC
DBClusterId	string	The cluster ID.	rm-uf6wjk5xxxxxxxxxx

Examples

Success response

JSON format

{
  "TaskId": 1564657730,
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC",
  "DBClusterId": "rm-uf6wjk5xxxxxxxxxx"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SecurityIPList.Duplicate	The specified IP address is duplicate.	The specified IP address is duplicate.
400	InvalidSecurityIPList.Malformed	The specified SecurityIPList is incorrectly formatted.	The specified security group parameter is invalid.
400	InvalidSecurityIPList.Duplicate	Specified security IP list is not valid: Duplicate IP address in the list	The specified IP address is duplicate. Specify a valid IP address.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.