• Elastic Load Balancing

elb
  1. Help Center
  2. Elastic Load Balancing
  3. API Reference
  4. Enhanced Load Balancer APIs
  5. Whitelist
  6. Querying Details of a Whitelist

Querying Details of a Whitelist

Function

This API is used to query details of a whitelist by its ID.

URI

GET /v2.0/lbaas/whitelists/{whitelist_id}

Table 1 Parameter description

Parameter

Type

Mandatory

Description

whitelist_id

Uuid

Yes

Specifies the whitelist ID.

Request

  • Request parameters

    None

  • Example request
    GET https://{Endpoint}/v2.0/lbaas/whitelists/09e64049-2ab0-4763-a8c5-f4207875dc3e

Response

  • Response parameters
    Table 2 Response parameters

    Parameter

    Type

    Description

    whitelist

    Dict

    Specifies the whitelist. For details, see Table 3.

    Table 3 whitelist field description

    Parameter

    Type

    Description

    id

    Uuid

    Specifies the whitelist ID.

    tenant_id

    String (255)

    Specifies the ID of the project where the forwarding rule is used.

    listener_id

    Uuid

    Specifies the ID of the listener to which the whitelist is added.

    enable_whitelist

    Bool

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

Response Codes

For details, see HTTP Status Codes for Enhanced Load Balancers.