Configuring IP Whitelist Groups

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 Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Range: N/A Default Value: N/A
instance_id	Yes	String	Definition: Instance ID. It can be viewed on the instance details page on the DCS console. Constraints: N/A Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
instance_id	No	String	Definition: Instance ID. Constraints: N/A Range: N/A Default Value: N/A
enable_whitelist	Yes	Boolean	Definition: Whether to enable the whitelist. Constraints: N/A Range: true: Yes false: No Default Value: N/A
whitelist	Yes	Array of Whitelist objects	Definition: IP whitelist group. New whitelist settings will overwrite the existing setting. Therefore, save the existing whitelist before you add a new one. Constraints: N/A

**Table 3** Whitelist
Parameter	Mandatory	Type	Description
group_name	Yes	String	Definition: Whitelist group name. Constraints: Each instance supports four whitelist groups. The group name must be unique, contain more than four characters, and start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. Range: N/A Default Value: N/A
ip_list	Yes	Array of strings	Definition: IP list in a whitelist group. Separate multiple IP addresses or IP address ranges with commas (,). Constraints: An instance's IPs must be unique. IP 0.0.0.0 and CIDP are not supported. Range: N/A Default Value: N/A

Response Parameters

Status code: 204

Definition:

IP whitelist groups configured successfully.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_msg	String	Definition: Error message. Range: N/A
error_code	String	Definition: Error code. Range: For details, see Error Codes.
error_ext_msg	String	Definition: Extended error information. This parameter is not used currently and is set to null. Range: N/A

Example Requests

Enabling the whitelist and configuring IP addresses allowed to access the instance

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" ]
  } ]
}

Enabling the whitelist and configuring subnet mask allowed to access the instance.
```
PUT https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist
```

Example Responses

None

Status Codes

Status Code	Description
204	Definition: IP whitelist groups configured successfully.
400	Definition: Invalid request.
401	Definition: Authentication failed.
403	Definition: Request rejected.
404	Definition: Incorrect path.
500	Definition: Internal error.