上报服务端命令执行结果
功能介绍
迁移Agent调用该接口向SMS服务端反馈指定指令的执行结果。
调用方法
请参见如何调用API。
URI
POST /v3/sources/{server_id}/command_result
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
server_id |
是 |
String |
上报命令执行结果的命令所对应的服务端ID 最小长度：0 最大长度：255 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：16384 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
command_name |
是 |
String |
命令名称，分为：START、STOP、DELETE、SYNC、UPLOAD_LOG、RSET_LOG_ACL 最小长度：0 最大长度：255 |
|
result |
是 |
String |
命令执行结果 success代表执行命令成功 fail代表命令执行失败 最小长度：0 最大长度：255 |
|
result_detail |
是 |
Object |
JSON格式的命令执行结果，只用于保存数据库，没有其他作用 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
上报服务端命令执行结果成功 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 最小长度：0 最大长度：255 |
|
error_msg |
String |
错误信息 最小长度：0 最大长度：1024 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
请求示例
反馈指定指令的执行结果给SMS服务端。指令为START，执行结果是“success”。
POST https://{endpoint}/v3/sources/f32ab4d6-d150-4fb3-aa55-edbb5cf9xxxx/command_result
{
"command_name" : "START",
"result" : "success",
"result_detail" : {
"msg" : "xxx"
}
}
响应示例
状态码：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 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
鉴权失败 |
|
404 |
Not Found |
|
500 |
Internal Server Error |
错误码
请参见错误码。
