接口功能介绍
查询DNAT列表信息
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/dnat/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| siteID | 是 | String | 站点 id | CTCB4NH03210700174 | |
| pageNo | 否 | Integer | 页码 | 8 | |
| pageSize | 否 | Integer | 每页记录数目 | 10 |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 查询dnat 信息 | result | |
| totalCount | 否 | Integer | 总数量 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| dnatID | 否 | String | 业务ID | e5b101a4-0f41-11ee-9fb1-525400af7402 | |
| siteID | 否 | String | 站点ID | CTCB4NH03210700174 | |
| internalIP | 否 | String | 本端私网IP | 123.45.22.22 | |
| protocol | 否 | String | 本参数表示协议 取值范围: TCP:TCP UDP:UDP |
||
| internalPort | 否 | String | 内网端口 | 10-20 | |
| externalPort | 否 | String | 外服务端口 | 10-20 |
请求示例
请求url
/sdwan/dnat/list?siteID=CTCB4NH03210700174
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"dnatID": "e5b101a4-0f41-11ee-9fb1-525400af7402",
"siteID": "CTCB4NH03210700174",
"internalIP": "123.45.22.22",
"protocol": "TCP",
"internalPort": "10-20",
"externalPort": "10-20"
}
],
"totalCount": 1,
"currentCount": 1
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Dnat.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
