文档

请求设备执行网络检测任务

更新时间:
一键部署

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

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

请求参数

名称

类型

是否必选

示例值

描述

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

返回数据

名称

类型

示例值

描述

code Int

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

message String

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

localizedMsg String

本地语言的错误消息。

data JSON

响应结果。

networkDetectTaskId String

网络检测任务ID。

示例

请求示例

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

正常返回示例

JSON格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "networkDetectTaskId": "cef5e617-2ed9-4bdd-9de2-f01df59805cd"
    }
}

异常返回示例

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 9543 intercom stream existed 对讲已经存在
  • 本页导读 (1)
文档反馈