接口功能介绍
查询DNAT规则
接口约束
已创建私网NAT实例
接口是否审批
否
URI
GET /v4/privatenat/list-dnats
Content-Type
application/json
路径参数
无
Query参数
Query参数| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
| -------------- | ---------- | ---------- | ----------------------- | ---------------------------------- |
| regionID | 是 | String | 区域id | 81f7728662dd11ec810800155d307d5b |
| natGatewayID | 是 | String | 要查询的私网NAT的ID | ngw-bp1uewa15k4iy5770 |
请求头header参数
无
请求体body参数
无
响应参数
| 响应参数 | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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 | Array of Objects | 见下表 | returnObj |
| 表 returnObj | 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dnatID | String | DNAT规则的ID | natdr-xxxxxx | ||
| externalIP | String | 中转IP | 192.168.22.22 | ||
| externalPort | Integer | 外部端口 | 8822 | ||
| internalIP | String | 内部IP | 10.0.10.1.22 | ||
| internalPort | Integer | 内部端口 | 8821 | ||
| portID | String | 对应的网卡ID | port-xxxxxx | ||
| portName | String | 网卡名称 | port-name | ||
| deviceID | String | 网卡对应的设备ID | xxxxxxxxxxxxx | ||
| protocol | String | 协议: tcp/udp | tcp | ||
| state | String | DNAT状态: running代表运行中, freeze代表已冻结, expired代表已到期 | running | ||
| createdAt | String | 创建时间 | |||
| description | String | 描述 | 这是一个描述 |
枚举参数
无
请求头header示例
无
请求url示例
GET /v4/privatenat/list-dnats?regionID=81f7728662dd11ec810800155d307d5b&natGatewayID=natgw-bp1uewa15k4`
请求体body示例
无
响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description":"",
"returnObj":[
{
"dnatID":"natdr-xxxxx",
"externalIP":"192.168.22.22",
"externalPort":8822,
"internalIP":"10.0.10.22",
"internalPort":8821,
"portID":"port-xxxxx",
"portName":"port-name",
"deviceID":"xxxxxxxxxx",
"protocol":"tcp",
"state":"running",
"createdAt":"2022-10-02T02:29:43Z",
"description":"this is a description"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功 |
错误码
请参考 错误码说明。
