文档

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

更新时间:
一键部署

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

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

请求参数

名称

类型

是否必选

示例值

描述

iotId String bZGD54swRgqo8d******000101 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
networkDetectType Int 1 网络检测类型。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.0",
		"iotToken": "token"
	},
	"params":{
		"iotId": "bZGD54swRgqo8d******000101",
		"networkDetectType":1
	}
}

正常返回示例

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
}
  • 本页导读 (0)
文档反馈