接口功能介绍
开启链路监控
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/link-detect/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| linkID | 是 | String | 链路Id | edffd3e2-bd4f-11ed-a635-005056893e3e | |
| detectPolicyList | 否 | Array of Objects | 专线链路探测对象 | detectPolicyList |
表detectPolicyList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| direction | 是 | String | 本参数表示探测方向 取值范围: to:下到源盒子 from:下到目的盒子 |
to | |
| detectIP | 是 | String | 探测IP | 10.1.1.2 | |
| nextHopIP | 是 | String | 下一跳地址 | 172.0.0.1 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| operationID | 否 | String | 操作日志Id | 176f56d6-bd5e-11ed-a635-005056893e3e |
请求示例
请求url
无
请求头header
无
请求体body
{
"linkID": "edffd3e2-bd4f-11ed-a635-005056893e3e",
"detectPolicyList": [
{
"direction": "to",
"detectIP": "10.1.1.2",
"nextHopIP": "172.0.0.1"
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": [
{
"operationID": "176f56d6-bd5e-11ed-a635-005056893e3e"
}
],
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| LinkDetect.SdwanSdwan.CreateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
