更新网络检测相关的信息
功能介绍
Agent 上报网络检测相关的信息。
调用方法
请参见如何调用API。
URI
POST /v3/{task_id}/update-network-check-info
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
任务id 最小长度:1 最大长度:36 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:16384 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain_connectivity |
否 |
Boolean |
域名连通性 |
|
destination_connectivity |
否 |
Boolean |
目的端连通性 |
|
network_delay |
是 |
Double |
网络时延 最小值:0 最大值:10000.0 |
|
network_jitter |
是 |
Double |
网络抖动 最小值:0 最大值:10000 |
|
migration_speed |
是 |
Double |
带宽 最小值:0 最大值:10000 |
|
loss_percentage |
是 |
Double |
丢包 最小值:0 最大值:100 |
|
cpu_usage |
是 |
Double |
CPU占用 最小值:0 最大值:100 |
|
mem_usage |
是 |
Double |
内存占用 最小值:0 最大值:100 |
|
evaluation_result |
是 |
String |
评估结果 最小长度:6 最大长度:8 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
任务ID 最小长度:1 最大长度:255 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度:0 最大长度:255 |
|
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误代码 最小长度:0 最大长度:255 |
|
error_msg |
String |
错误信息 最小长度:0 最大长度:255 |
|
encoded_authorization_message |
String |
加密授权信息 最小长度:0 最大长度:65535 |
|
error_param |
Array of strings |
错误参数 最小长度:0 最大长度:65535 数组长度:1 - 20 |
|
details |
Array of details objects |
详细错误信息 数组长度:1 - 20 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
SMS错误代码 最小长度:0 最大长度:65535 |
|
error_msg |
String |
SMS错误信息 最小长度:0 最大长度:65535 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度:0 最大长度:255 |
|
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度:0 最大长度:255 |
|
error_msg |
String |
错误信息 最小长度:0 最大长度:1024 |
请求示例
更新任务ID为137224b7-8d7c-4919-b33e-ed159778xxxx 的网络质量检测结果。
POST https://{endpoint}/v3/137224b7-8d7c-4919-b33e-ed159778xxxx/update-network-check-info
{
"network_delay" : "20.00",
"network_jitter" : "2.00",
"migration_speed" : "100.00",
"loss_percentage" : "0.00",
"cpu_usage" : "20.00",
"mem_usage" : "20.00",
"evaluation_result" : ""
}
响应示例
状态码:200
更新网络检测结果成功。
{
"task_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001"
}
状态码:403
鉴权失败
{
"error_code" : "SMS.9004",
"error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.",
"encoded_authorization_message" : "XXXXXX",
"error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
"details" : [ {
"error_code" : "SMS.9004",
"error_msg" : "You do not have permission to perform action XXX on resource XXX."
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
更新网络检测结果成功。 |
|
400 |
缺少请求参数。 |
|
403 |
鉴权失败 |
|
404 |
任务不存在 |
|
500 |
更新网络检测结果异常。 |
错误码
请参见错误码。