Adding IP Addresses to the Whitelist Group

Function

This API is used to add IP addresses to the whitelist group for a specified instance.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v2/{project_id}/instance/{instance_id}/whitelist-async

**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
whitelist	Yes	Array of Whitelist objects	Definition: IP address list to be added to a whitelist group. IP addresses or CIDR blocks are supported. Constraints: N/A Range: N/A Default Value: 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: 200

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition: ID of the task for adding IP addresses to the whitelist. Range: N/A

Status code: 400

**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: 401

**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: 403

**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: 404

**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

Status code: 500

**Table 9** 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

POST https://{dcs_endpoint}/v2/{project_id}/instance/{instance_id}/whitelist-async

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

Example Responses

Status code: 200

Return body for adding IP address whitelist groups.

{
  "job_id" : "ff8080817fe01bb2017fe3cf68860481"
}

Status Codes

Status Code	Description
200	Return body for adding IP address whitelist groups.
400	Invalid request.
401	Authentication failed.
403	Request rejected.
404	Incorrect path.
500	Internal error.