Updated on 2024-07-29 GMT+08:00

Modifying a P2C VPN Gateway

Function

This API is used to modify a P2C VPN gateway with a specified ID.

Calling Method

For details, see Calling APIs.

URI

PUT /v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}

Table 1 Parameter description

Parameter

Type

Mandatory

Description

project_id

String

Yes

Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.

p2c_vgw_id

String

Yes

Specifies the ID of a P2C VPN gateway instance.

Request

  • Request parameters
    Table 2 Request parameters

    Parameter

    Type

    Mandatory

    Description

    p2c_vpn_gateway

    UpdateP2cVgwRequestBodyContent

    object

    Yes

    Specifies the P2C VPN gateway object.

    Table 3 UpdateP2cVgwRequestBodyContent

    Parameter

    Type

    Mandatory

    Description

    name

    String

    No

    • Specifies the name of a P2C VPN gateway.
    • The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), and hyphens (-).

    eip_id

    String

    No

    • Specifies the ID of a valid EIP, which is the new EIP to be bound to a P2C VPN gateway. Before binding a new EIP, unbind the original EIP from the VPN gateway by referring to Updating an EIP.
    • The value is a UUID containing 36 characters.
  • Example request
    PUT https://{Endpoint}/v5/{project_id}/p2c-vpn-gateways/{p2c_vgw_id}
    
    {
      "p2c_vpn_gateway": {
        "name": "p2c-vpngw-0003",
        "eip_id": "d9d85143-e1e1-427a-9994-d8b8fd9ebe3f"
      }
    }

Response

  • Response parameters

    Returned status code 200: successful operation

    Table 4 Parameters in the response body

    Parameter

    Type

    Description

    p2c_vpn_gateway

    ResponseP2cVgw object

    Specifies the P2C VPN gateway object.

    request_id

    String

    Specifies a request ID.

    Table 5 ResponseP2cVgw

    Parameter

    Type

    Description

    id

    String

    • Specifies the ID of a P2C VPN gateway.
    • The value is a UUID containing 36 characters.
  • Example response
    {
        "p2c_vpn_gateway": {
            "id": "10d176c7-aed8-4766-9180-a47e536c64d0"
        },
        "request_id": "b19ba5a0be8f7b7f664b14596f8f35db"
    }

Status Codes

For details, see Status Codes.