Help & DocumentationVirtual Private CloudAPI DocumentationVPC API 2017APIs for NAT GatewayModify NAT Gateways
1. API Description
This API (ModifyNatGateway) is used to modify NAT gateways.
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-x7d44d. |
| natId | Yes | string | Unified ID of NAT gateway, for example: nat-df45454. |
| natName | No | string | NAT gateway name. It supports 1-25 characters, including uppercase and lowercase English letters, numbers, and underscores. |
| bandwidth | No | int | The maximum public network output bandwidth of the gateway (unit: Mbps), which is 100 Mbps by default. For more information about supported data, please refer to Virtual Private Cloud Gateway Description. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| code | Int | Error code. 0: succeeded, other values: Failed |
| message | String | Error message |
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 |
| InvalidNatGatewayName | The NAT gateway name is invalid. Valid NAT gateway name shall have a length of 1-60 characters, and can contain uppercase and lowercase English letters, numbers, and underscores |
5. Example
Input
https://vpc.api.qcloud.com/v2/index.php?Action=ModifyNatGateway
&<Common request parameters>
&natId=nat-jngbqyfs
&vpcId=314
&natName=cici
Output
{
"code":"0",
"message":""
}
