获取服务端命令
功能介绍
迁移Agent调用该接口从SMS服务端获取下发给指定源端迁移Agent的命令。
调用方法
请参见如何调用API。
URI
GET /v3/sources/{server_id}/command
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
server_id |
是 |
String |
命令对应的服务器ID 最小长度：0 最大长度：255 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
X-Auth-Token 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：1 最大长度：16384 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
command_name |
String |
命令名称，分为：START、STOP、DELETE、SYNC 最小长度：0 最大长度：255 |
|
command_param |
ComandParam object |
命令响应参数 |
状态码：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 |
请求示例
获取ID为f32ab4d6-d150-4fb3-aa55-edbb5cf9947f的源端的当前需要执行的命令
GET https://{endpoint}/v3/sources/f32ab4d6-d150-4fb3-aa55-edbb5cf9947f/command
响应示例
状态码：200
获取服务端命令成功
{
"command_name" : "START",
"command_param" : {
"task_id" : "xxxxxxxxxxxxxxxxxxxxxxxx00000001"
}
}
状态码：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 |
错误码
请参见错误码。
