Querying the IP Whitelist of a DCS Instance

Function

This API is used to query the IP address whitelist of a specific instance.

URI

GET /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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
instance_id	String	Definition: Instance ID. Range: N/A
enable_whitelist	Boolean	Definition: Whether the whitelist is enabled. Range: true: Yes false: No
whitelist	Array of WhitelistResp objects	Definition: Current instance IP whitelist.
whitelist_ip_limit_num	String	Definition: Maximum number of IP addresses allowed in the IP whitelist of a tenant instance. Range: N/A

**Table 3** WhitelistResp
Parameter	Type	Description
group_name	String	Definition: Whitelist group name. Range: N/A
ip_list	Array of strings	Definition: IP list in a whitelist group. Range: N/A

Example Requests

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

Example Responses

Status code: 200

Instance whitelist queried successfully.

{
  "instance_id" : "5560df16-cebf-4473-95c4-d1b573c16e79",
  "enable_whitelist" : true,
  "whitelist" : [ {
    "group_name" : "test001",
    "ip_list" : [ "10.10.10.1", "10.10.10.2" ]
  } ],
  "whitelist_ip_limit_num" : 20
}