文档首页/ NAT网关 NAT/ API参考（安卡拉区域）/ API（私网NAT网关）/ 私网NAT网关/ 创建私网NAT网关
更新时间：2024-04-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建私网NAT网关

功能介绍

创建私网NAT网关实例。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/private-nat/gateways

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

最小长度：1

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：1

最大长度：10240
表3 请求Body参数

参数

是否必选

参数类型

描述

gateway

是

CreatePrivateNatOption object

创建私网NAT网关实例的请求体。
表4 CreatePrivateNatOption

参数

是否必选

参数类型

描述

name

是

String

私网NAT网关实例的名字。 私网NAT网关实例的名字仅支持数字、字母、_（下划线）、-（中划线）、中文。

最小长度：1

最大长度：64

description

否

String

私网NAT网关实例的描述。长度范围小于等于255个字符，不能包含“<”和“>”。

最小长度：0

最大长度：255

spec

否

String

私网NAT网关实例的规格。 取值为： "Small"：小型 "Medium"：中型 "Large"：大型 "Extra-large"：超大型

缺省值：Small

枚举值：

  • Small

  • Medium

  • Large

  • Extra-large

downlink_vpcs

是

Array of DownlinkVpcOption objects

私网NAT网关实例所属的VPC实例。

数组长度：1 - 1

tags

否

Array of Tag objects

标签列表

数组长度：0 - 10

enterprise_project_id

否

String

企业项目ID 创建私网NAT网关实例时，关联的企业项目ID。 关于企业项目ID的获取及企业项目特性的详细信息，请参考《企业管理用户指南》。

缺省值：0

最小长度：1

最大长度：36
表5 DownlinkVpcOption

参数

是否必选

参数类型

描述

virsubnet_id

是

String

私网NAT网关实例所属的子网的ID。

最小长度：36

最大长度：36
表6 Tag

参数

是否必选

参数类型

描述

key

是

String

标签key值。

最小长度：1

最大长度：128

value

是

String

标签value。

最小长度：0

最大长度：255

响应参数

状态码： 201

表7 响应Body参数

参数

参数类型

描述

gateway

PrivateNat object

私网NAT网关实例的响应体。

request_id

String

请求ID。

最小长度：1

最大长度：36
表8 PrivateNat

参数

参数类型

描述

id

String

私网NAT网关实例的ID。

最小长度：36

最大长度：36

project_id

String

项目的ID。

最小长度：32

最大长度：32

name

String

私网NAT网关实例的名字。

最小长度：1

最大长度：64

description

String

私网NAT网关实例的描述。长度范围小于等于255个字符，不能包含“<”和“>”。

最小长度：0

最大长度：255

spec

String

私网NAT网关实例的规格。 取值为： "Small"：小型 "Medium"：中型 "Large"：大型 "Extra-large"：超大型

缺省值：Small

枚举值：

  • Small

  • Medium

  • Large

  • Extra-large

status

String

私网NAT网关实例的状态。 取值为： "ACTIVE"：正常运行 "FROZEN"：冻结

枚举值：

  • ACTIVE

  • FROZEN

created_at

String

私网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。

updated_at

String

私网NAT网关实例的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。

downlink_vpcs

Array of DownlinkVpc objects

私网NAT网关实例所属的VPC实例。

数组长度：1 - 10

tags

Array of Tag objects

标签列表。

数组长度：1 - 10

enterprise_project_id

String

企业项目ID。 创建私网NAT网关实例时，关联的企业项目ID。

最小长度：1

最大长度：36
表9 DownlinkVpc

参数

参数类型

描述

vpc_id

String

私网NAT网关实例所属VPC的ID。

最小长度：36

最大长度：36

virsubnet_id

String

私网NAT网关实例所属子网的ID。

最小长度：36

最大长度：36
表10 Tag

参数

参数类型

描述

key

String

标签key值。

最小长度：1

最大长度：128

value

String

标签value。

最小长度：0

最大长度：255

请求示例

创建私网NAT网关实例，其中，私网NAT网关实例的名称为private-nat-gateway-name，实例的规格为Small，所属的子网的id为373979ee-f4f0-46c5-80e3-0fbf72646b70。

POST https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways

{
  "gateway" : {
    "name" : "private-nat-gateway-name",
    "description" : "private-nat-gateway-description",
    "spec" : "Small",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "downlink_vpcs" : [ {
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ],
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  }
}

响应示例

状态码： 201

创建私网NAT网关实例成功。

{
  "request_id" : "9882046a9b96f1405472e36d797e33dc",
  "gateway" : {
    "id" : "14338426-6afe-4019-996b-3a9525296e11",
    "name" : "private-nat-gateway-name",
    "description" : "private-nat-gateway-description",
    "spec" : "Small",
    "project_id" : "70505c941b9b4dfd82fd351932328a2f",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "status" : "ACTIVE",
    "created_at" : "2019-04-22T08:47:13",
    "updated_at" : "2019-04-22T08:47:13",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "downlink_vpcs" : [ {
      "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2",
      "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70"
    } ]
  }
}

状态码

状态码

描述

201

创建私网NAT网关实例成功。

错误码

请参见错误码。

父主题： 私网NAT网关