Help & Documentation Virtual Private Cloud API Documentation VPC API 2017 APIs for NAT Gateway Upgrade NAT Gateway Specifications

Upgrade NAT Gateway Specifications

Last updated: 2017-08-10 14:56:02

PDF

Contents:

1. API Description

This API (UpgradeNatGateway) is used to upgrade the NAT gateway specification.
Domain for API request: vpc.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters.

Parameter Name Required Type Description
vpcId Yes string Virtual private cloud ID or unified ID (unified ID is recommended), for example: vpc-xdf54d
natId Yes string Unified ID of highly available gateway, for example: nat-xdf54d
maxConcurrent Yes int Maximum gateway concurrent connections. Available values include 1,000,000 (small), 3,000,000 (medium) and 10,000,000 (large)

3. Output Parameters

Parameter Name Type Description
code Int Error code. 0: Succeeded; other values: Failed.
message String Error message
billId string Order ID. You can query the upgrade result by calling Query Upgrade Status of NAT Gateway

4. Error Codes

The following error code list only provides the business logic error codes for this API. For additional common error codes, refer to VPC Error Codes.

Error Code Description
InvalidVpc.NotFound Invalid VPC. VPC resource does not exist. Please verify that the resource information you entered is correct. You can query the VPC via the DescribeVpcEx API
InvalidNatGatewayId.NotFound Invalid NAT gateway, NAT gateway resource does not exist. Please verify that the resource information you entered is correct. You can query the NAT gateway via the DescribeNatGateway API

5. Example

Input


https://vpc.api.qcloud.com/v2/index.php?Action=UpgradeNatGateway
&<Common request parameters>
&vpcId=314
&natId=nat-et8e970y
&maxConcurrent=3000000

Output

{
    "code":"0",
    "message":"",
    "billId":"20160416160000002485261276560190"
}