Hongwei, King Wang 32c06a10a2 vpn_api

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Hongwei, King Wang <king.wanghongwei@huawei.com>
Co-committed-by: Hongwei, King Wang <king.wanghongwei@huawei.com>

2024-08-15 14:18:28 +00:00

13 KiB

Raw Permalink Blame History

Querying VPN Endpoint Groups

Function

This API is used to query VPN endpoint groups.

URI

GET /v2.0/vpn/endpoint-groups

Request

Table 1 describes the request parameter.

**Table 1** Request parameter
Parameter	Type	Mandatory	Description
fields	String	No	Controls which parameters are returned. If this parameter is not specified, all parameters will be returned.

Parameter project_id is not supported.

Response

Table 2 describes the response parameters.

**Table 2** Response parameters
Parameter	Type	Description
description	String	Provides supplementary information about the VPN endpoint group.
tenant_id	String	Specifies the project ID.
endpoints	List	Specifies the endpoint list. The endpoints in a list must be of the same type.
type	String	Specifies the endpoint type, which can be subnet or cidr.
id	String	Specifies the ID of the VPN endpoint group.
name	String	Specifies the name of the VPN endpoint group.
endpoint_groups	List<Object>	Specifies the object of the VPN endpoint groups.

Example

Example request
```
GET /v2.0/vpn/endpoint-groups
```

Example response

{
    "endpoint_groups": [
        {
            "description": "",
            "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
            "endpoints": [
                "a3da778c-adfb-46db-88b3-d2ce53290a89"
            ],
            "type": "subnet",
            "id": "6bf34c7c-864c-4948-a6d4-db791669f9d4",
            "name": "locals"
        },
        {
            "description": "",
            "tenant_id": "4ad57e7ce0b24fca8f12b9834d91079d",
            "endpoints": [
                "10.2.0.0/24",
                "10.3.0.0/24"
            ],
            "type": "cidr",
            "id": "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
            "name": "peers"
        }
    ]
}

Returned Values

For details, see Common Returned Values.

Parent topic: VPN Endpoint Group Management

13 KiB Raw Permalink Blame History