tencent cloud

Feedback

CreateLoadBalancerSnatIps

Last updated: 2022-02-23 11:25:04

1. API Description

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

This API is used to add an SNAT IP for an SnatPro CLB instance. If SnatPro is not enabled for CLB, it will be automatically enabled after the SNAT IP is added.
This is an async API. After it is returned successfully, you can check the task result by calling DescribeTaskStatus with the returned RequestID.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateLoadBalancerSnatIps.
Version Yes String Common parameter. The value used for this API: 2018-03-17.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
LoadBalancerId Yes String Unique ID of a CLB instance, e.g., lb-12345678.
SnatIps.N Yes Array of SnatIp Information of the SNAT IP to be added. You can specify a SNAT IP or use the one automatically assigned by a subnet.
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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Adding a SNAT IP

Input Example

https://clb.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 Specifying a SNAT IP

Input Example

https://clb.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.
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.
LimitExceeded Quota exceeded.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support