接口功能介绍
创建 dnat 规则
接口约束
需要先创建 NAT 网关
URI
POST /v4/vpc/create-dnat-entry
请求参数
请求体Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 区域id | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| natGatewayID | String | 是 | natgw-1o5sdqb7i2 | nat 网关 ID |
| externalID | String | 是 | 弹性公网id | eip-3ubjeszr3a |
| externalPort | Integer | 是 | 弹性IP公网端口, 1 - 65535 | 80 |
| serverType | String | 否 | 当 virtualMachineType 为 1 是，serverType 必传，支持: VM / BM （仅支持大写） | VM |
| virtualMachineID | String | 否 | 云主机 | 62dab755-1f54-b961-307e-4a0c84274a09 |
| virtualMachineType | Integer | 是 | 云主机类型1-选择云主机，virtualMachineID字段必传 2-自定义，internalIp必传 | 1 |
| internalIp | String | 否 | 内部 IP | 0.0.0.0 |
| internalPort | Integer | 是 | 主机内网端口 | 80 |
| protocol | String | 是 | 支持协议：tcp/udp | tcp |
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| description | String | 否 | 支持拉丁字母、中文、数字, 特殊字符：~!@#$%^&*()_-+= <>?:"{} | ,./;'[]·~！@#￥%……&*（） ——-+={} |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Object | 业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| dnat | Object | 业务数据 | 见下表 |
表 dnat
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| status | String | 绑定状态，取值 in_progress / done | in_progress |
| message | String | 绑定状态提示信息 | 请使用相同请求，进行重试 |
| dnatID | String | dnat id, 当 status != done 时，dnatID 为 null | null |
请求示例
POST /v4/vpc/create-dnat-entry
请求体Body
{
"externalID":"eip-3ubjeszr3a",
"internalPort":100,
"externalPort":200,
"virtualMachineID":"62dab755-1f54-b961-307e-4a0c84274a09",
"virtualMachineType":1,
"protocol":"tcp",
"natGatewayID":"natgw-1o5sdqb7i2",
"internalIp":"192.168.58.128",
"desc":"aaa",
"regionId": "81f7728662dd11ec810800155d307d5b",
"clientToken": "xxxxxx"
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"dnat": {
"status": "in_progress",
"message": "请使用相同请求，进行重试",
"dnatID": null
}
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
