Configuring IP Whitelist Groups¶

Note

IP whitelist groups are supported only by DCS Redis 4.0/5.0 instances, and not by DCS Redis 3.0 instances

Function¶

This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one.

URI¶

PUT /v2/{project_id}/instance/{instance_id}/whitelist

**Table 1** Path parameter¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
instance_id	Yes	String	Instance ID.

Request Parameters¶

**Table 2** Request body parameters¶
Parameter	Mandatory	Type	Description
enable_whitelist	Yes	Boolean	Whether to enable the whitelist. Options: true false
whitelist	Yes	Array of Whitelist objects	IP whitelist group.

**Table 3** Whitelist¶
Parameter	Mandatory	Type	Description
group_name	Yes	String	Whitelist group name. A maximum of four groups can be created for each instance.
ip_list	Yes	Array of strings	List of IP addresses in the whitelist group. A maximum of 20 IP addresses or IP address ranges can be added to an instance. Separate multiple IP addresses or IP address ranges with commas (,). IP address 0.0.0.0 and IP address range 0.0.0/0 are not supported.

Response Parameters¶

Status code: 400

**Table 4** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum length: 1024 characters
error_code	String	Error code. Maximum length: 9 characters
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum length: 1024 characters

Status code: 401

**Table 5** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum length: 1024 characters
error_code	String	Error code. Maximum length: 9 characters
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum length: 1024 characters

Status code: 403

**Table 6** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum length: 1024 characters
error_code	String	Error code. Maximum length: 9 characters
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum length: 1024 characters

Status code: 404

**Table 7** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum length: 1024 characters
error_code	String	Error code. Maximum length: 9 characters
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum length: 1024 characters

Status code: 500

**Table 8** Response body parameters¶
Parameter	Type	Description
error_msg	String	Error information. Maximum length: 1024 characters
error_code	String	Error code. Maximum length: 9 characters
error_ext_msg	String	Extended error information. This parameter is not used currently and is set to null. Maximum length: 1024 characters

Example Request¶

PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist

{
  "enable_whitelist" : true,
  "whitelist" : [ {
    "group_name" : "test001",
    "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
  } ]
}

Example Response¶

None

Status Codes¶

Status Code	Description
204	IP whitelist groups configured successfully.
400	Invalid request.
401	Invalid authentication information.
403	The request is rejected.
404	The requested resource could not be found.
500	Internal service error

Error Codes¶

See Error Codes.

last updated: 2024-04-24 01:19