tencent cloud

CreateLoadBalancerSnatIps
Last updated: 2025-11-25 10:11:08
CreateLoadBalancerSnatIps
Last updated: 2025-11-25 10:11:08

1. API Description

Domain name for API request: clb.intl.tencentcloudapi.com.

This API is used to add SnatIp for SnatPro Cloud Load Balancer. If SnatPro is not enabled, it will be auto on after adding SnatIp.
This API is used to perform asynchronous operations. After returning a successful result, call the DescribeTaskStatus API with the returned RequestID as an input parameter to check whether this task is successful.

A maximum of 20 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: CreateLoadBalancerSnatIps.
Version Yes String Common Params. The value used for this API: 2018-03-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String Specifies the unique ID of the cloud load balancer. you can call the DescribeLoadBalancers API to query the ID, such as lb-12345678.
SnatIps.N Yes Array of SnatIp Added SnatIp information. specify IP for request or designated subnet for automatic application. can be accessed through DescribeSubnets to query and retrieve. the default upper limit for one CLB instance is 10.
Number No Integer Number of SNAT IPs to be added. This parameter is used in conjunction with SnatIps. Note that if Ip is specified in SnapIps, this parameter is not available. It defaults to 1 and the upper limit is 10.

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 Adding a SnatIp

This example shows you how to create a specified Number of snat IPs.

Input Example

https://clb.intl.tencentcloudapi.com/?Action=CreateLoadBalancerSnatIps
&LoadBalancerId=lb-cuxw****
&SnatIps.0.SubnetId=subnet-1234****
&Number=2
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "898b431c-2745-4b27-80f6-e6e8038a0683"
    }
}

Example2 Assigning a snat ip and Adding a SnatIp

This example shows you how to add a snat ip by specifying an ip.

Input Example

https://clb.intl.tencentcloudapi.com/?Action=CreateLoadBalancerSnatIps
&LoadBalancerId=lb-cuxw****
&SnatIps.0.SubnetId=subnet-1234****
&SnatIps.0.Ip=192.168.1.2
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "898b431c-80f6-80f6-80f6-e6e8038a0683"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
FailedOperation Operation failed.
FailedOperation.ResourceInOperating The specified resource is currently being operated. Please try again later.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameter.LBIdNotFound Wrong CLB instance ID.
InvalidParameter.RegionNotFound Invalid region.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Length Wrong parameter length.
LimitExceeded Quota exceeded.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback