文档

CreateNatIp - 创建NAT IP地址

更新时间:

调用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代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

要创建 NAT IP 地址所属 NAT 网关实例的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

eu-central-1
NatGatewayIdstring

NAT IP 地址所属的 VPC NAT 网关实例 ID。

ngw-gw8v16wgvtq26vh59****
NatIpNamestring

创建的 NAT IP 地址的名称。

长度为 2~128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。但不能以http://https://开头。

newnatip
NatIpDescriptionstring

创建的 NAT IP 地址的描述信息。

长度为 2~256 个字符,必须以字母或中文开头,但不能以http://https://开头。

test
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会创建 NAT IP 地址。检查项包括 AccessKey 是否有效、RAM 用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 2xx HTTP 状态码并创建 NAT IP 地址。

false
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF3898
NatIpCidrstring

创建 NAT IP 地址的地址段。

192.168.0.0/24
NatIpstring

创建的 NAT IP 地址。

如果您不指定该 IP 地址,系统会在您的 NAT IP 地址段中随机分配一个 IP 地址。

192.168.0.34

返回参数

名称类型描述示例值
object

创建的 NAT IP 地址。

NatIpstring

创建的 NAT IP 地址。

192.168.0.34
RequestIdstring

请求 ID。

E9AD97A0-5338-43F8-8A80-5E274CCBA11B
NatIpIdstring

创建的 NAT IP 地址实例 ID。

vpcnatip-gw8y7q3cpk3fggs8****

示例

正常返回示例

JSON格式

{
  "NatIp": "192.168.0.34",
  "RequestId": "E9AD97A0-5338-43F8-8A80-5E274CCBA11B",
  "NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****"
}

错误码

HTTP status code错误码错误信息描述
400Mismatch.NatIpAndNatIpCidrThe %s and %s are mismatched.%s和%s不匹配。
400ResourceNotFound.NatGatewayThe specified resource of %s is not found.-
400ResourceNotFound.NatIpCidrThe specified resource of %s is not found.找不到指定的%s资源。
400IncorrectStatus.NatGateway%The status of %s [%s] is incorrect.nat网关状态不正确
400QuotaExceeded.NatIpThe quota of %s is exceeded, usage %s/%s.-
400ResourceAlreadyExist.NatIpThe specified resource of %s is already exist.-
400ResourceNotEnough.SwitchAvailableIpsThe available private Ip number is not enough in your subnet.子网中可用的私网IP不足。
400ResourceNotEnough.NatIpThe specified resource of NatIp is not enough.Insufficient IP addresses in the specified CIDR block.
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    删除入参:NatIpCidrId
2023-06-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
  • 本页导读 (1)