调用CreateSnatEntry接口在SNAT列表中添加SNAT条目。

API描述

调用本接口添加SNAT条目时,请注意:

  • CreateSnatEntry接口属于异步接口,即系统会先返回一个SNAT条目ID,但该SNAT条目并未添加完成,系统后台的添加任务仍在进行。您可以调用DescribeNatGateways查询SNAT条目的状态:
    • 当SNAT条目处于Pending状态时,表示SNAT条目正在添加中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当SNAT条目处于Available状态时,表示SNAT条目添加完成。
  • SNAT条目中指定的交换机和ECS实例必须在NAT网关所属的VPC内。
  • 每个交换机和ECS实例只能属于一个SNAT条目。
  • 如果交换机中存在HAVIP实例,则无法添加SNAT条目。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateSnatEntry

要执行的操作,取值:CreateSnatEntry

RegionId String cn-hangzhou

NAT网关所在的地域。 您可以通过调用DescribeRegions接口获取地域ID。

SnatIp String 47.xx.xx.98

公网IP地址,多个IP之间用逗号隔开。

说明 指定多个公网IP配置SNAT IP地址池时,需确保每个公网IP都加入到同一个共享带宽中。
SnatTableId String stb-bp190wu8io1vgev****

SNAT表ID。

SourceVSwitchId String vsw-bp1nhx2s9ui5o****

需要公网访问的交换机的ID。

SourceCIDR String 10.1.1.0/24

交换机或ECS实例的网段。

  • 交换机粒度:指定交换机的网段(如192.168.1.0/24),当交换机下的ECS实例发起互联网访问请求时,NAT网关会为其提供SNAT服务(代理上网服务)。如果SnatIp仅指定了一个公网IP,ECS实例使用指定的公网IP访问互联网;如果SnatIp指定了多个公网IP,ECS实例随机使用SnatIp中的公网IP访问互联网。
  • ECS粒度:指定ECS实例的地址(如192.168.1.1/32),当ECS实例发起互联网访问请求时,NAT网关会为其提供SNAT服务(代理上网服务)。如果SnatIp仅指定了一个公网IP,ECS实例使用指定的公网IP访问互联网;如果SnatIp指定了多个公网IP,ECS实例随机使用SnatIp中的公网IP访问互联网。

此参数和SourceVSwtichId参数互斥,不能同时出现。如果指定了SourceVSwitchId,则不能指定SourceCIDR参数。如果指定了SourceCIDR参数,则不能指定SourceVSwitchId参数。

SnatEntryName String SnatEntry-1

SNAT条目的名称。

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

ClientToken String 02fb3da4-130e-11e9-8e44-001sdfg

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

返回数据

名称 类型 示例值 描述
SnatEntryId String snat-kmd6nv8fy****

SNAT条目ID。

RequestId String 2315DEB7-5E92-423A-91F7-4C1EC9AD97C3

请求ID。

示例

请求示例

https://vpc.aliyuncs.com/?Action=CreateSnatEntry
&RegionId=cn-hangzhou
&SnatIp=47.xx.xx.98
&SnatTableId=stb-bp190wu8io1vgevx****
&<公共请求参数>

正常返回示例

XML 格式

<CreateSnatEntryResponse>
      <RequestId>2315DEB7-5E92-423A-91F7-4C1EC9AD97C3</RequestId>
      <SnatEntryId>snat-119smw5tkx****</SnatEntryId>
</CreateSnatEntryResponse>

JSON 格式

{
    "SnatEntryId": "snat-kmd6nv8fyx****",
    "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD97C3"
}