全部产品
Search
文档中心

NAT 网关:CreateNatIpCidr - 创建NAT IP地址段

更新时间:Dec 03, 2023

调用CreateNatIpCidr接口创建NAT IP地址段。

接口说明

CreateNatIpCidr接口在同一个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****
NatIpCidrNamestring

NAT IP地址段的名称。

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

newcidr
NatIpCidrDescriptionstring

NAT IP地址段的描述信息。

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

mycidr
DryRunboolean

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

  • true:发送检查请求,不会创建NAT IP地址段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
false
ClientTokenstring

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

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

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

创建的NAT IP地址段。

新建的地址段必须满足以下条件:

  • 属于10.0.0.0/8、172.16.0.0/12或192.168.0.0/16网段及其子网。
  • 支持的子网掩码位数范围为16至32位。
  • 不能与VPC NAT网关所属VPC的私网网段重叠。如果您需要将私网地址转换为VPC私网网段内的其他地址,请在对应的VPC私网网段内创建交换机,然后在该交换机中创建新的VPC NAT网关提供私网地址转换服务。
  • 如需使用公网地址段作为NAT IP地址段,则该地址段必须属于VPC NAT网关所属VPC的用户网段。关于用户网段的更多信息,请参见什么是用户网段
172.16.0.0/24

返回参数

名称类型描述示例值
object
NatIpCidrIdstring

创建的NAT IP地址段的实例ID。

vpcnatcidr-gw8lhqtvdn4qnea****
RequestIdstring

请求ID。

7021BEB1-210F-48A9-AB82-BE9A9110BB89

示例

正常返回示例

JSON格式

{
  "NatIpCidrId": "vpcnatcidr-gw8lhqtvdn4qnea****",
  "RequestId": "7021BEB1-210F-48A9-AB82-BE9A9110BB89"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectStatus.NatGatewayThe status of %s [%s] is incorrect.-
400OperationFailed.NatIpCidrInUseThe operation is failed because of %s.-
400QuotaExceeded.NatIpCidrThe quota of %s is exceeded, usage %s/%s.-
400OperationFailed.CreateNatIpCidrInVpcCidrBlockThe operation is failed because of Creating NatIpCidr in Vpc Cidr.-
400OperationFailed.CreateNatIpCidrNotInUserCidrThe operation is failed because of Creating NatIpCidr not in UserCidr.由于创建NatIpCidr不在UserCidr中,操作失败。
400ResourceAlreadyExist.NatIpCidrThe specified resource of %s is already exist.-
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.指定的RegionId不存在。
404ResourceNotFound.NatGatewayThe specified resource of %s is not found.-
404ResourceNotFound.VPCThe specified resource of %s is not found.-

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

变更历史

变更时间变更内容概要操作
2023-03-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404