更新时间:2022-08-02 GMT+08:00

获取服务端命令

功能介绍

迁移Agent调用该接口从SMS服务端获取下发给指定源端迁移Agent的命令。

迁移Agent自动调用此接口用于获取服务端命令,您无需调用此接口。

URI

GET /v1/sms/sources/{source_id}/command

参数说明请参见表1
表1 参数说明

参数

是否必选

描述

source_id

源端服务器的ID

请求消息

响应消息

响应参数

响应参数如表2所示。

表2 响应参数

参数

参数类型

描述

command_name

String

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

command_param

Json

命令参数,请参见表3

表3 command_param信息

参数

参数类型

描述

key1

String

命令参数

key2

String

命令参数

示例

  • 请求示例

    无请求消息。

  • 响应示例
    • 启动迁移任务
      {
      "command_name":"START",
      "command_param":{
      "task_id":"2c0689c860ad4728a497c91ec0844384"
      }
      }
    • 停止迁移任务
      {
      "command_name":"STOP",
      "command_param":{
      "task_id":"2c0689c860ad4728a497c91ec0844384"
      }
      }
    • 同步迁移任务
      {
      "command_name":"SYNC"
      "command_param":{
      "task_id":"2c0689c860ad4728a497c91ec0844384"
      }
      }
    • 删除迁移任务
      {
      "command_name":"DELETE"
      "command_param":{
      "task_id":"2c0689c860ad4728a497c91ec0844384"
      }
      }
    • 收集迁移日志到用户指定的OBS桶
      {
      "command_name":"UPLOAD_LOG"
      "command_param":{
      "bucket":"logbucket"
      "object":""
      }
      }

状态码

状态码请参见状态码