更新时间:2024-04-18 GMT+08:00

创建DNAT规则

功能介绍

创建DNAT规则。

接口约束

创建规则时,要求网关状态status = "ACTIVE"。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/private-nat/dnat-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

最小长度:1

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

dnat_rule

CreatePrivateDnatOption object

创建DNAT规则的请求体。

表4 CreatePrivateDnatOption

参数

是否必选

参数类型

描述

description

String

DNAT规则的描述。长度范围小于等于255个字符,不能包含“<”和“>”。

最小长度:0

最大长度:255

transit_ip_id

String

中转IP的ID。

最小长度:36

最大长度:36

network_interface_id

String

网络接口ID,支持计算、ELB、VIP等实例的网络接口。

最小长度:36

最大长度:36

gateway_id

String

私网NAT网关实例的ID。

最小长度:36

最大长度:36

protocol

String

协议类型。 目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。

最小长度:1

最大长度:3

枚举值:

  • tcp

  • udp

  • any

private_ip_address

String

后端实例的私网IP地址。

最小长度:7

最大长度:15

internal_service_port

String

后端实例的端口号。

最小长度:1

最大长度:5

transit_service_port

String

中转IP的端口号。

最小长度:1

最大长度:5

响应参数

状态码: 201

表5 响应Body参数

参数

参数类型

描述

dnat_rule

PrivateDnat object

DNAT规则的响应体。

request_id

String

请求ID。

最小长度:1

最大长度:36

表6 PrivateDnat

参数

参数类型

描述

id

String

DNAT规则的ID。

最小长度:36

最大长度:36

project_id

String

项目的ID。

最小长度:36

最大长度:36

description

String

DNAT规则的描述。长度范围小于等于255个字符,不能包含“<”和“>”。

最小长度:1

最大长度:36

transit_ip_id

String

中转IP的ID。

最小长度:36

最大长度:36

gateway_id

String

私网NAT网关实例的ID。

最小长度:1

最大长度:36

network_interface_id

String

网络接口ID,支持计算、ELB、VIP等实例的端口。

最小长度:1

最大长度:36

type

String

DNAT规则后端的类型。 取值: COMPUTE:后端为计算实例。 VIP:后端为VIP的实例。 ELB:后端为ELB的实例。 ELBv3:后端为ELBv3的实例。 CUSTOMIZE:后端为自定义IP。

最小长度:1

最大长度:10

protocol

String

协议类型。 目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。

最小长度:1

最大长度:3

枚举值:

  • tcp

  • udp

  • any

private_ip_address

String

后端实例的私网IP地址。

最小长度:7

最大长度:15

internal_service_port

String

后端实例的端口号。

最小值:0

最大值:65535

最小长度:1

最大长度:5

transit_service_port

String

中转IP的端口号。

最小值:0

最大值:65535

最小长度:1

最大长度:5

enterprise_project_id

String

企业项目ID。创建DNAT规则时,关联的企业项目ID。

最小长度:1

最大长度:36

created_at

String

DNAT规则的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

最小长度:1

最大长度:36

updated_at

String

DNAT规则的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

最小长度:1

最大长度:36

请求示例

创建DNAT规则,其中,中转IP的id为3faa719d-6d18-4ccb-a5c7-33e65a09663e,私网NAT网关实例的id为0adefb29-a6c2-48a5-8637-2be67fa03fec。

POST https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules

{
  "dnat_rule" : {
    "description" : "aa",
    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707"
  }
}

响应示例

状态码: 201

创建DNAT规则成功。

{
  "dnat_rule" : {
    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "description" : "aa",
    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
    "type" : "COMPUTE",
    "protocol" : "any",
    "internal_service_port" : "0",
    "transit_service_port" : "0",
    "private_ip_address" : "192.168.1.72",
    "created_at" : "2019-04-29T07:10:01",
    "updated_at" : "2019-04-29T07:10:01"
  },
  "request_id" : "70505c941b9b4dfd82fd351932328a2f"
}

状态码

状态码

描述

201

创建DNAT规则成功。

错误码

请参见错误码