调用CreateNatIp接口创建NAT IP地址。
接口说明
使用说明
CreateNatIp接口属于异步接口，即系统会先返回一个NAT IP地址，但该NAT IP地址并未创建完成，系统后台的创建任务仍在进行。您可以调用ListNatIps查询NAT IP地址创建的状态：
-
当NAT IP地址处于Creating状态时，表示NAT IP地址正在创建中，在该状态下，您只能执行查询操作，不能执行其他操作。
-
当NAT IP地址处于Available状态时，表示NAT IP地址创建完成。
CreateNatIp接口在同一个NAT网关内不支持并发创建NAT IP地址。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 要创建NAT IP地址所属NAT网关实例的地域ID。 您可以通过调用DescribeRegions接口获取地域ID。 | eu-central-1 |
| NatGatewayId | string | 是 | NAT IP地址所属的VPC NAT网关实例ID。 | ngw-gw8v16wgvtq26vh59**** |
| NatIpName | string | 是 | 创建的NAT IP地址的名称。 长度为2~128个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。但不能以 | newnatip |
| NatIpDescription | string | 是 | 创建的NAT IP地址的描述信息。 长度为2~256个字符，必须以字母或中文开头，但不能以 | test |
| DryRun | boolean | 否 | 是否只预检此次请求，取值：
| false |
| ClientToken | string | 否 | 客户端Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明
若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
| 5A2CFF0E-5718-45B5-9D4D-70B3FF3898 |
| NatIpCidr | string | 是 | 创建NAT IP地址的地址段。 | 192.168.0.0/24 |
| NatIp | string | 否 | 创建的NAT IP地址。 如果您不指定该IP地址，系统会在您的NAT IP地址段中随机分配一个IP地址。 | 192.168.0.34 |
返回参数
示例
正常返回示例
JSON格式
{
"NatIp": "192.168.0.34",
"RequestId": "E9AD97A0-5338-43F8-8A80-5E274CCBA11B",
"NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Mismatch.NatIpAndNatIpCidr | The %s and %s are mismatched. | %s和%s不匹配。 |
| 400 | ResourceNotFound.NatGateway | The specified resource of %s is not found. | - |
| 400 | ResourceNotFound.NatIpCidr | The specified resource of %s is not found. | 找不到指定的%s资源。 |
| 400 | IncorrectStatus.NatGateway | %The status of %s [%s] is incorrect. | nat网关状态不正确 |
| 400 | QuotaExceeded.NatIp | The quota of %s is exceeded, usage %s/%s. | - |
| 400 | ResourceAlreadyExist.NatIp | The specified resource of %s is already exist. | - |
| 400 | ResourceNotEnough.SwitchAvailableIps | The available private Ip number is not enough in your subnet. | 子网中可用的私网IP不足。 |
| 400 | ResourceNotEnough.NatIp | The specified resource of NatIp is not enough. | Insufficient IP addresses in the specified CIDR block. |
| 404 | InvalidRegionId.NotFound | The specified RegionId does not exist in our records. | 指定的RegionId不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2023-07-03 | OpenAPI 错误码发生变更，OpenAPI 入参发生变更 | 看变更集 | ||||||||||
| ||||||||||||
| 2023-06-09 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||
|