Upgrading a VPN Gateway

This API is used to upgrade a VPN gateway.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
vpn:vpnGateways:upgrade	write	vpnGateways	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

POST /v5/{project_id}/vpn-gateways/{vgw_id}/upgrade

**Table 1** Parameters in a request
Parameter	Type	Description
project_id	String	Specifies a project ID.
vgw_id	String	Specifies the ID of a VPN gateway instance.

**Table 2** UpgradeRequestBody
Parameter	Type	Mandatory	Description
action	String	Yes	Specifies an upgrade operation. Value range: start finish rollback

Example request

POST https://{Endpoint}/v5/{project_id}/vpn-gateways/{vgw_id}/upgrade

{
    "action": "start"
}

**Table 3** Parameters in the response body
Parameter	Type	Description
job_id	String	Specifies a task ID.
request_id	String	Specifies a request ID.

Example response

{
    "job_id": "c7f1d3e3-0476-4a71-95a7-3ce8cbb969de",
    "request_id": "73f072d8-demo-a8df-va86-2a755d95636f"
}

For details, see Status Codes.

Parent topic: S2C VPN Gateway

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.