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

创建中转IP

功能介绍

创建中转IP。

调用方法

请参见如何调用API。

URI

POST /v3/{project_id}/private-nat/transit-ips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

最小长度：1

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：1

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

参数

是否必选

参数类型

描述

transit_ip

是

CreatTransitIpOption object

创建中转IP的请求体。
表4 CreatTransitIpOption

参数

是否必选

参数类型

描述

virsubnet_id

是

String

当前项目子网的ID。

最小长度：1

最大长度：36

ip_address

否

String

中转IP地址。

最小长度：7

最大长度：35

enterprise_project_id

否

String

企业项目ID。创建中转IP时，关联的企业项目ID。

缺省值：0

最小长度：1

最大长度：36

tags

否

Array of Tag objects

标签

数组长度：0 - 2000
表5 Tag

参数

是否必选

参数类型

描述

key

是

String

标签key值。

最小长度：1

最大长度：128

value

是

String

标签value。

最小长度：0

最大长度：255

响应参数

状态码： 201

表6 响应Body参数

参数

参数类型

描述

transit_ip

TransitIp object

中转子网IP的响应体。

request_id

String

请求ID。

最小长度：1

最大长度：36
表7 TransitIp

参数

参数类型

描述

id

String

中转IP的ID。

最小长度：36

最大长度：36

project_id

String

项目的ID。

最小长度：1

最大长度：36

network_interface_id

String

中转IP的网络接口ID。

最小长度：36

最大长度：36

ip_address

String

中转IP的地址。

最小长度：7

最大长度：35

created_at

String

中转IP的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ

最小长度：1

最大长度：36

updated_at

String

中转IP的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ

最小长度：1

最大长度：36

virsubnet_id

String

当前租户子网的ID。

最小长度：0

最大长度：36

tags

Array of Tag objects

标签列表。

数组长度：1 - 10

gateway_id

String

中转IP绑定的私网NAT网关实例的ID。

最小长度：36

最大长度：36

enterprise_project_id

String

企业项目ID。创建中转IP时，关联的企业项目ID。

最小长度：1

最大长度：36
表8 Tag

参数

参数类型

描述

key

String

标签key值。

最小长度：1

最大长度：128

value

String

标签value。

最小长度：0

最大长度：255

请求示例

创建中转IP，其中，当前项目子网的id为2759da7b-8015-404c-ae0a-a389007b0e2a，中转IP地址为192.168.1.68，创建中转IP时，关联的企业项目id为2759da7b-8015-404c-ae0a-a389007b0e2a。

POST https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips

{
  "transit_ip" : {
    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "ip_address" : "192.168.1.68",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  }
}

响应示例

状态码： 201

创建中转IP成功。

{
  "transit_ip" : {
    "id" : "a2845109-3b2f-4627-b08f-09a726c0a6e7",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "network_interface_id" : "adebbdca-8c26-4c14-b34f-3f53cd2c42f2",
    "ip_address" : "192.168.1.68",
    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "created_at" : "2019-04-29T02:16:09",
    "updated_at" : "2019-04-29T02:16:09",
    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  },
  "request_id" : "747a911c17067a39692f75ac146fb47e"
}

状态码

状态码

描述

201

创建中转IP成功。

错误码

请参见错误码。

父主题： 中转IP