CreateNatIp--NAT网关-火山引擎

文档中心

立即注册

导航

CreateNatIp

最近更新时间：2024.07.16 19:49:26首次发布时间：2023.11.07 08:15:17

调用 CreateNatIp 接口，添加中转IP。

说明

私网NAT网关正在邀测中，如需试用，请联系客户经理。

接口说明

私网NAT网关所在的子网有空闲的私网IP地址。
私网NAT网关已添加的中转IP数量未达到配额值，请参考约束限制。
当前账户未欠费或欠费时间在2小时内，更多操作请参考充值操作指引。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	CreateNatIp	要执行的操作，取值：CreateNatIp。
Version	String	是	2020-04-01	API的版本信息，当前版本为：2020-04-01。
NatGatewayId	String	是	ngw-2feq5xhimd88w59gp686****	私网NAT网关ID。
NatIpName	String	否	nat_ip_1	中转IP的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短划线（-）。不填默认为中转IP的ID。
NatIpDescription	String	否	natip-1	中转IP的描述。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
NatIp	String	否	192.168.XX.34	中转IP的地址。若不填，则系统自动从私网NAT网关所在子网随机分配一个空闲的IP地址。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
NatIpId	String	vpcnatip-gw8y7q3cpk3fggs8****	中转IP的ID。

请求示例

GET /?Action=CreateNatIp&Version=2020-04-01&NatGatewayId=ngw-2feq5xhimd88w59gp686****&NatIp=192.168.XX.34 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: natgateway
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateNatIp",
        "Version": "2020-04-01",
        "Service": "natgateway",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "2021062415303301022514515207C4****",
        "NatIpId": "vpcnatip-gw8y7q3cpk3fggs8****"
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidIPAddress.Malformed	The specified IP address is malformed.	指定的IP不合法。
400	InvalidEni.InvalidStatus	The specified elastic network interface is not in the correct status for the request.	指定的弹性网卡所处的状态无法响应该请求。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidNatGateway.InvalidStatus	The specified NAT gateway is not in the correct status for the request.	指定的NAT网关所处的状态无法响应该请求。
400	InvalidNatGateway.NatIpNotSupported	The specified NAT gateway does not support creating nat ip.	指定的NAT网关实例不支持创建NAT IP。
400	MissingParameter	The request is missing a required parameter.	该请求缺少必要参数。
400	QuotaExceeded.NatIp	NAT IPs number of the cidr exceeded quota.	已达到一个cidr可创建的NAT中转IP的数量上限。
400	InvalidNatGateway.NotFound	The specified NAT gateway does not exist.	指定的NAT网关不存在。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的项目不存在。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。
412	InvalidNatGateway.Expired	The specified NAT gateway has expired.	指定的NAT网关已到期。
500	InternalError	An internal error has occurred.	发生内部错误。