文档

查询设备网络检测任务的结果

更新时间:
一键部署

调用该接口查询设备网络检测任务的结果。接口仅限于客户端网络问题排查的低频场景使用,不能用于其他产品功能。

路径 /vision/customer/network/detect/get
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 可选
超时时间 3000

请求参数

名称

类型

是否必选

示例值

描述

iotId String bZGD54swRgqo8d******000101 设备ID。
networkDetectType Int 网络检测类型。1: 端口连通性;2: MTU;4: 网络带宽;8: 网络延时。
networkDetectTaskId String 设备网络检测任务ID。

返回数据

名称

类型

示例值

描述

code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

networkDetectType Int

网络检测类型。1: 端口连通性;2: MTU;4: 网络带宽;8: 网络延时。

networkDetectTaskId String

网络检测任务ID。

createTime Long

网络检测任务创建时间。

status String

任务状态。RUNNING:运行中;FAIL:失败;SUCCESS:成功。

result String

任务执行结果描述。

portResult JSON

端口检测结果。

ip String

服务IP。

port Int

服务端口。

reachable Boolean

是否可连接。

mtuResult JSON

MTU检测结果。

ip String

服务IP。

mtu Int

MTU大小。

bandwidthResult JSON

网络带宽检测结果。

uploadSpeed JSON

网络上传速度。单位Mbps。

downloadSpeed JSON

网络下载速度。单位Mbps。

pingResult JSON

网络延时检测结果。

ip String

服务IP。

delay JSON

网络延时。单位ms。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1"
	},
	"params":{
		"iotId": "bZGD54swRgqo8d******000101",
		"networkDetectType": "value1",
		"networkDetectTaskId": "value2"
	}
}

正常返回示例

JSON格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "networkDetectType": 1,
        "networkDetectTaskId": "cef5e617-2ed9-4bdd-9de2-f01df59805cd",
        "craeteTime": 1644478817,
        "status": "RUNNING",
        "result": "",
        "portResult": [],
        "mtuResult": [],
        "bandwidthResult": {},
        "pingResult": []
    }
}

异常返回示例

JSON格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}

错误码

HttpCode

错误码

错误信息

描述

500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 4047 invalid param. 无效的参数
200 4047 invalid param. 无效的参数
200 4047 invalid param. 无效的参数
  • 本页导读 (1)
文档反馈