-
响应示例 返回状态码为200：查询ping探测结果信息成功，响应体参考PingReplyResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "The device does not exist.",
"data" : {
"taskId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2",
"totalCount" : 5,
"successCount" : 5,
"lossRate" : 100,
"rttAvg" : 5,
"status" : 1,
"PingReply" : {
"data" : [
{
"sequence" : 5,
"dataByte" : 5,
"ttlOrHoplimit" : 100,
"rtt" : 5,
"result" : 1
}
]
}
}
} 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500：内部服务器错误，无响应体。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应参数 返回状态码为200：查询ping探测结果信息成功，响应体参考PingReplyResponse。 表2 PingReplyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "The device does not exist." data REFERENCE 详细请参见表3。 ping任务返回结果 - 表3 PingReplyResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 taskId string - - ping探测任务ID，格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" totalCount integer - - 总探测次数。 5 successCount integer - - 成功探测次数。 5 lossRate float - - 丢失率。单位：百分比。 100 rttAvg integer - - 报文平均响应时间，单位：毫秒。 5 status integer - - 探测状态。 0 --- 成功 1 --- 执行中 2 --- 超时 3 --- 失败 1 PingReply REFERENCE 详细请参见表4。 ping探测任务返回具体信息。 - 表4 PingReply对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表5。 ping探测任务返回具体信息。 - 表5 PingReplySingle对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sequence integer - - 探测序号。 5 dataByte integer - - 响应报文的长度，单位：字节。 5 ttlOrHoplimit integer - - 生存时间值，单位：毫秒。 100 rtt integer - - 响应时间，单位：毫秒。 5 result integer - - 探测状态。 0 --- 成功 1 --- 执行中 2 --- 超时 1 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误，无响应体。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/ping/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
-
请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/ping HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"deviceId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2",
"destination" : "192.168.7.3",
"pingSelf" : false
}
-
响应示例 返回状态码为201：创建ping探测任务成功，响应体参考PingTaskResponse。 HTTP/1.1 201 Created
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "The device does not exist.",
"data" : {
"taskId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2",
"destination" : "192.168.7.3",
"status" : 1
}
} 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500：内部服务器错误，无响应体。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 request 是 REFERENCE 详细请参见表2。 请求参数。 - 表2 PingDiagnoseDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID，UUID格式。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" destination 否 string 0~253个字符。 - ping目的地址，可以是IP地址或
域名 ，域名中不能包含空格。 当pingSelf字段为false时,必须设置该字段 "192.168.7.3" pingSelf 是 boolean true false - 是否探测自身IP地址。默认为false false
-
响应参数 返回状态码为201：创建ping探测任务成功，响应体参考PingTaskResponse。 表3 PingTaskResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "The device does not exist." data REFERENCE 详细请参见表4。 创建ping任务的返回信息 - 表4 PingTaskDiagnose对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 taskId string - - ping探测任务ID，格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" destination string - - 目的地址。可以是IP地址或域名，域名中不能包含空格。 "192.168.7.3" status integer - - 探测状态。当探测状态为1时，会根据任务ID查询任务结果。探测状态取值如下： 0 --- 成功 1 --- 执行中 2 --- 超时 1 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误，无响应体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：查询Trace探测结果成功，响应体参考TraceReplyResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "The device does not exist.",
"data" : {
"taskId" : "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2",
"destination" : "192.168.7.3",
"status" : 1,
"TraceHopList" : {
"data" : [
{
"hopIndex" : 1,
"hopAddress" : "192.168.7.3",
"TraceProbeList" : {
"data" : [
{
"probeIndex" : 1,
"result" : 1,
"deltaTime" : 1,
"probeAddress" : "192.168.7.3"
}
]
}
}
]
}
}
} 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500：内部服务器错误，无响应体。 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应参数 返回状态码为200：查询Trace探测结果成功，响应体参考TraceReplyResponse。 表2 TraceReplyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "The device does not exist." data REFERENCE 详细请参见表3。 trace任务返回结果 - 表3 TraceReplyResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 taskId string - - trace探测任务ID，格式UUID。 "75ade72a-e7a9-4c81-8fca-894e7ca9c2c2" destination string - - 目的地址。可以是IP地址或域名，域名中不能包含空格。 "192.168.7.3" status integer - - 探测状态。 0 --- 已完成 1 --- 执行中 2 --- 超时 3 --- 失败 1 TraceHopList REFERENCE 详细请参见表4。 trace探测任务返回具体信息。 - 表4 TraceHopList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表5。 trace探测任务返回具体信息。 - 表5 TraceHopDiagnose对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 hopIndex integer - - 跳数索引。 1 hopAddress string - - 该跳地址。可以是IP地址或域名，域名中不能包含空格。 "192.168.7.3" TraceProbeList REFERENCE 详细请参见表6。 trace探测任务单跳返回具体信息。 - 表6 TraceProbeList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表7。 trace探测任务单跳返回具体信息。 - 表7 TraceProbeDiagnose对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 probeIndex integer - - 单跳探测索引。 1 result integer - - 探测状态。 0 --- 已完成 1 --- 执行中 2 --- 超时 3 --- 失败 1 deltaTime integer - - 探测增量时间。 1 probeAddress string - - 单跳探测地址。可以是IP地址或域名，域名中不能包含空格。 "192.168.7.3" 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误，无响应体。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/trace/75ade72a-e7a9-4c81-8fca-894e7ca9c2c2 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
