Virtual Private Cloud
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Quick Start
- VPC Connections
- Operation Guide
- Virtual Private Cloud (VPC)
- Classiclink
- Subnets
- Route Tables
- IPs and ENIs
- Network Connection
- Security Management
- Security Groups
- Managing Security Groups
- Managing Security Group Rules
- Network ACL
- Parameter Template
- Diagnostic Tools
- Traffic Mirroring
- Practical Tutorial
- Migrating from the Classic Network to VPC
- Best Practices of Security Group Change
- Troubleshooting
- API Documentation
- Making API Requests
- VPC APIs
- Route Table APIs
- Elastic Public IP APIs
- Elastic IPv6 APIs
- Highly Available Virtual IP APIs
- ENI APIs
- Bandwidth Package APIs
- NAT Gateway APIs
- Direct Connect Gateway APIs
- Cloud Connect Network APIs
- Network ACL APIs
- Network Detection-Related APIs
- Flow Log APIs
- Gateway Traffic Monitor APIs
- Private Link APIs
- Other APIs
- Subnet APIs
- VPN Gateway APIs
- Security Group APIs
- Network Parameter Template-Related APIs
- Snapshot Policy APIs
- FAQs
ModifyNatGatewayAttribute
Last updated: 2024-11-25 20:04:52
1. API Description
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to modify the attributes of a NAT gateway.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyNatGatewayAttribute. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| NatGatewayId | Yes | String | The ID of the NAT gateway, such as nat-df45454. |
| NatGatewayName | No | String | The NAT gateway name, such as test_nat. |
| InternetMaxBandwidthOut | No | Integer | The maximum outbound bandwidth of the NAT gateway. Unit: Mbps. |
| ModifySecurityGroup | No | Boolean | Whether to modify the security group bound to the NAT gateway |
| SecurityGroupIds.N | No | Array of String | The final security groups bound to the NAT Gateway, such as ['sg-1n232323', 'sg-o4242424']. An empty list indicates that all the security groups have been deleted. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Modifying the attributes of a NAT Gateway
This example shows you how to modify the NAT gateway name and maximum outbound bandwidth. To adjust the maximum concurrent connections of a NAT gateway, please use ResetNatGatewayConnection.
Input Example
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNatGatewayAttribute
<Common request parameters>
{
"InternetMaxBandwidthOut": "500",
"NatGatewayId": "nat-ig8xpno8",
"NatGatewayName": "Test natNAT gateway"
}
Output Example
{
"Response": {
"RequestId": "e5c289dc-bf4b-4828-8093-3c434d1f0886"
}
}
Example2 Changing the SNAT mode of a NAT gateway
This example shows you how to modify the StrictSnatMode status of a NAT gateway
Input Example
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNatGatewayAttribute
<Common request parameters>
{
"NatGatewayId": "nat-owj32fec"
}
Output Example
{
"Response": {
"RequestId": "5acefde4-3be5-4582-a432-742081e1c904"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue.Malformed | Invalid input parameter format. |
| InvalidParameterValue.TooLong | Invalid parameter value. The parameter value is too long. |
| ResourceInUse | The resource is occupied. |
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation | Unsupported operation. |
| UnsupportedOperation.InsufficientInternetServiceProviders |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No