1. 接口描述
接口请求域名： clb.tencentcloudapi.com 。
针对SnatPro负载均衡，这个接口用于添加SnatIp，如果负载均衡没有开启SnatPro，添加SnatIp后会自动开启。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateLoadBalancerSnatIps。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| LoadBalancerId | 是 | String | 负载均衡唯一性ID，例如：lb-12345678。 示例值：lb-cuxw**** |
| SnatIps.N | 是 | Array of SnatIp | 添加的SnatIp信息，可指定IP申请，或者指定子网自动申请。单个CLB实例可申请的默认上限为10个。 |
| Number | 否 | Integer | 添加的SnatIp的个数，可与SnatIps一起使用，但若指定IP时，则不能指定创建的SnatIp个数。默认值为1，数量上限与用户配置有关，默认上限为10。 示例值：2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加SnatIp
输入示例
https://clb.tencentcloudapi.com/?Action=CreateLoadBalancerSnatIps
&LoadBalancerId=lb-cuxw****
&SnatIps.0.SubnetId=subnet-1234****
&Number=2
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "898b431c-2745-4b27-80f6-e6e8038a0683"
}
}示例2 指定snat ip添加SnatIp
输入示例
https://clb.tencentcloudapi.com/?Action=CreateLoadBalancerSnatIps
&LoadBalancerId=lb-cuxw****
&SnatIps.0.SubnetId=subnet-1234****
&SnatIps.0.Ip=192.168.1.2
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "898b431c-80f6-80f6-80f6-e6e8038a0683"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InvalidParameter.LBIdNotFound | 负载均衡实例ID错误。 |
| InvalidParameter.RegionNotFound | 地域无效。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Length | 参数长度错误。 |
| LimitExceeded | 超过配额限制。 |