Modifies an IP address whitelist of an ApsaraDB for ClickHouse cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyDBClusterAccessWhiteList

The operation that you want to perform. Set the value to ModifyDBClusterAccessWhiteList.

DBClusterId String Yes cc-bp1qx68m06981****

The ID of the cluster.

SecurityIps String Yes 192.168.xx.xx

The content of the IP address whitelist. You can specify the content in the following formats:

  • IP address. For example, specify 192.168.0.1 to allow access from this IP address to the ApsaraDB for ClickHouse cluster.
  • CIDR block. For example, specify 192.168.0.0/24 to allow access from the IP addresses from 192.168.0.1 to 192.168.0.255 to the ApsaraDB for ClickHouse cluster.
    Note
    • Do not specify 0.0.0.0.
    • If you specify 127.0.0.1, all IP addresses are blocked and the ApsaraDB for ClickHouse cluster cannot be accessed.
DBClusterIPArrayName String No default

The name of the IP address whitelist that you want to modify.

Note If you do not specify this parameter, the default IP address whitelist is modified.
DBClusterIPArrayAttribute String No NULL

The attribute of the IP address whitelist. By default, this parameter is NULL.

ModifyMode String No Cover

The method that is used to modify the IP address whitelist. Valid values:

  • Cover: overwrites the original IP address whitelist.
  • Append: appends the specified IP addresses to the original IP address whitelist.
  • Delete: deletes the original IP address whitelist.
Note If you do not specify this parameter, the value Cover is used by default.

Response parameters

Parameter Type Example Description
RequestId String D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

The ID of the request.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=ModifyDBClusterAccessWhiteList
&DBClusterId=cc-bp1qx68m06981****
&SecurityIps=192.168.xx.xx
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBClusterAccessWhiteListResponse>
    <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</ModifyDBClusterAccessWhiteListResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified value for the DBClusterId parameter does not exist. Check whether the value is valid.

For a list of error codes, see Service error codes.