主机迁移服务 SMS主机迁移服务 SMS

更新时间:2021/09/14 GMT+08:00
分享

上报服务端命令执行结果

功能介绍

迁移Agent调用该接口向SMS服务端反馈指定指令的执行结果。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/sources/{server_id}/command_result

表1 路径参数

参数

是否必选

参数类型

描述

server_id

String

上报命令执行结果的命令所对应的服务端id

最小长度:0

最大长度:255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:16384

表3 请求Body参数

参数

是否必选

参数类型

描述

command_name

String

命令名称,分为:START、STOP、DELETE、SYNC、UPLOAD_LOG、RSET_LOG_ACL

最小长度:0

最大长度:255

result

String

命令执行结果  success代表执行命令成功  fail代表命令执行失败

最小长度:0

最大长度:255

result_detail

Object

JSON格式的命令执行结果,只用于保存数据库,没有其他作用

响应参数

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:255

error_msg

String

错误信息

最小长度:0

最大长度:1024

请求示例

上报命令执行结果

POST https://{endpoint}/v3/sources/f32ab4d6-d150-4fb3-aa55-edbb5cf9947f/command_result

{
  "command_name" : "START",
  "result" : "success",
  "result_detail" : {
    "msg" : "xxx"
  }
}

响应示例

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品