Help Center/ Elastic Load Balance/ API Reference/ API (V2)/ Whitelist/ Querying Details of a Whitelist

Updated on 2023-12-18 GMT+08:00

View PDF

Querying Details of a Whitelist

Function

This API is used to query details about a whitelist using its ID.

URI

GET /v2/{project_id}/elb/whitelists/{whitelist_id}

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
whitelist_id	Yes	String	Specifies the whitelist ID.

Request

None

Response

**Table 2** Parameter description
Parameter	Type	Description
whitelist	Whitelist object	Specifies the whitelist. For details, see Table 3.

**Table 3** **whitelist** parameter description
Parameter	Type	Description
id	String	Specifies the whitelist ID.
tenant_id	String	Specifies the ID of the project where the whitelist is used. The value contains a maximum of 255 characters.
listener_id	String	Specifies the ID of the listener to which the whitelist is added.
enable_whitelist	Boolean	Specifies whether to enable access control. true: Access control is enabled. false: Access control is disabled.
whitelist	String	Specifies the IP addresses in the whitelist.

Example Request

Example request: Querying details of a whitelist

GET https://{Endpoint}/v2/eabfefa3fd1740a88a47ad98e132d238/elb/whitelists/09e64049-2ab0-4763-a8c5-f4207875dc3e

Example Response

Example response

{ 
    "whitelist": { 
        "id": "eabfefa3fd1740a88a47ad98e132d238",  
        "listener_id": "eabfefa3fd1740a88a47ad98e132d238",  
        "tenant_id": "eabfefa3fd1740a88a47ad98e132d238",  
        "enable_whitelist": true,  
        "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" 
    } 
}