ExecuteMigrationOperation - 执行迁移操作

指定的迁移任务执行指定的操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:ExecuteMigrationOperation

update

*Instance

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

POST /migrations/{migrationId}/stages/{stageType}/operations/{operationId}/execute HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

migrationId

integer

迁移 ID

44

instanceId

string

实例 ID。

rmq-cn-x0r37kel***

stageType

string

迁移阶段类型,消息迁移(MIGRATE_MESSAGE)

枚举值:

  • MIGRATE_MESSAGE :

    消息迁移

MIGRATE_MESSAGE

operationId

integer

迁移操作 ID

2729

body

object

请求体结构。

operationParam

object

操作参数

paramData

any

参数信息,参数类型为 json 字符串,参考示例。

action(操作)字段枚举值如下:

  • MIGRATE_FORWARD(迁移前进)

  • MIGRATE_BACKWARD(迁移回退)

targetStage(目标阶段)字段枚举值如下:

  • MIGRATE_WAIT(读写源集群)

  • DOUBLE_READ(写源集群冗余读)

  • SWITCH_WRITE(写目标集群冗余读)

  • MIGRATE_FINISH(读写目标集群)

说明
  • 关于迁移前进,只能按照顺序逐个阶段向前推进。

  • 关于迁移回滚,可以回滚至之前的任何一个阶段。

迁移前进:{"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"} 迁移后退:{"action":"MIGRATE_BACKWARD","targetStage":"MIGRATE_WAIT"}

返回参数

名称

类型

描述

示例值

object

Result

requestId

string

请求 ID

814BCD66-2D76-5080-AAD2-E50E5BDB0995

success

boolean

是否成功

true

data

object

返回结果

operationId

integer

迁移操作 ID

110

migrationId

integer

迁移 ID

6

stageType

string

迁移阶段类型

枚举值:

  • MIGRATE_MESSAGE :

    迁移消息

MIGRATE_MESSAGE

operationType

string

操作类型:MIGRATE_MESSAGE(迁移消息)

MIGRATE_MESSAGE

operationStatus

string

操作状态:

  • INIT(未开始)

  • DOING(执行中)

  • DONE(已完成)

  • FAIL(已失败)

枚举值:

  • INIT :

    未开始

  • DONE :

    已完成

  • DOING :

    执行中

  • FAIL :

    已失败

DOING

operationKey

string

操作对象主键

normal-topic-1

businessStatus

string

操作业务状态:

  • MIGRATE_WAIT(读写源集群)

  • DOUBLE_READ(写源集群冗余读)

  • SWITCH_WRITE(写目标集群冗余读)

  • MIGRATE_FINISH(读写目标集群)

  • ALREADY_MIGRATED(已迁移)

枚举值:

  • MIGRATE_CHECK :

    读写源集群

  • SWITCH_WRITE :

    写目标集群冗余读

  • MIGRATE_FINISH :

    读写目标集群

  • DOUBLE_READ :

    写源集群冗余读

  • ALREADY_MIGRATED :

    已迁移

MIGRATE_WAIT

operationParam

object

操作参数

paramData

any

参数信息

{"action":"MIGRATE_FORWARD","targetStage":"MIGRATE_FINISH"}

operationResult

object

操作结果

resultData

any

操作结果

{ "checkStatus": "WAIT_CHECK", "sourceTopicStatus": "PERM_6", "targetTopicStatus": "PERM_4", "checkResult": {}, "migrateStage": "DOUBLE_READ" }

createTime

string

创建时间

2022-08-01 20:05:50

updateTime

string

修改时间

2022-08-01 20:05:50

code

string

错误码

Topic.NotFound

message

string

错误信息

The topic already exists.

httpStatusCode

integer

HTTP 状态码

200

dynamicCode

string

动态错误码

InstanceId

dynamicMessage

string

动态错误信息

instanceId

示例

正常返回示例

JSON格式

{
  "requestId": "814BCD66-2D76-5080-AAD2-E50E5BDB0995",
  "success": true,
  "data": {
    "operationId": 110,
    "migrationId": 6,
    "stageType": "MIGRATE_MESSAGE",
    "operationType": "MIGRATE_MESSAGE",
    "operationStatus": "DOING",
    "operationKey": "normal-topic-1",
    "businessStatus": "MIGRATE_WAIT",
    "operationParam": {
      "paramData": "{\"action\":\"MIGRATE_FORWARD\",\"targetStage\":\"MIGRATE_FINISH\"}"
    },
    "operationResult": {
      "resultData": "{\n    \"checkStatus\": \"WAIT_CHECK\",\n    \"sourceTopicStatus\": \"PERM_6\",\n    \"targetTopicStatus\": \"PERM_4\",\n    \"checkResult\": {},\n    \"migrateStage\": \"DOUBLE_READ\"\n}"
    },
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50"
  },
  "code": "Topic.NotFound",
  "message": "The topic already exists.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情