ModifyDBClusterAccessWhiteList - ApsaraDB for ClickHouse

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

clickhouse:ModifyDBClusterAccessWhiteList

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-bp1qx68m06981****
SecurityIps	string	Yes	The IP address whitelist. The following formats are supported: IP address: For example, 192.168.0.1. This allows the specified IP address to access the ApsaraDB for ClickHouse cluster. CIDR block: For example, 192.168.0.0/24. This allows IP addresses from 192.168.0.1 to 192.168.0.255 to access the ApsaraDB for ClickHouse cluster. Note Do not enter 0.0.0.0. Set this parameter to 127.0.0.1 to block access from all IP addresses.	192.168.xx.xx
DBClusterIPArrayName	string	No	The name of the whitelist group to modify. Note If you do not specify this parameter, the whitelist of the default group is modified.	default
DBClusterIPArrayAttribute	string	No	The attribute of the whitelist group. The default value is empty.	NULL
ModifyMode	string	No	The modification method. Valid values: Cover: Overwrites the whitelist. Append: Adds IP addresses to the whitelist. Delete: Removes IP addresses from the whitelist. Note If you do not specify this parameter, the Cover method is used by default.	Cover

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

Examples

Success response

JSON format

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.