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

17 KiB

Raw Permalink Blame History

Updating a VPN Endpoint Group

Function

This API is used to update a VPN endpoint group.

URI

PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
endpoint_group_id	String	Yes	Specifies the ID of the VPN endpoint group.

Request

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Type	Mandatory	Description
description	String	No	Provides supplementary information about the VPN endpoint group. The description can contain up to 255 characters.
name	String	No	Specifies the name of the VPN endpoint group. The name can contain 1 to 64 characters.
endpoint_group	Object	Yes	Specifies the endpoint group.

Parameter project_id is not supported.

Response

Table 3 describes the response parameters.

**Table 3** 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	Provides supplementary information about the VPN endpoint group.
endpoint_group	Object	Specifies the object of the VPN endpoint group.

Example

Example request

PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}
{
  "endpoint_group" : {
    "description" : "New description"
  }
}

Example response

{
  "endpoint_group" : {
    "description" : "New 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

17 KiB Raw Permalink Blame History