ListMigrationOperations - 查询迁移操作列表

查询迁移操作列表。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

rocketmq:ListMigrationOperations

list

*Instance

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

请求语法

GET /migrations/{migrationId}/stages/{stageType}/operations HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

migrationId

integer

迁移 ID。

135

stageType

string

迁移阶段类型。

枚举值:

  • MIGRATE_MESSAGE :

    消息迁移

MIGRATE_MESSAGE

operationType

string

操作类型。

枚举值:

  • MIGRATE_MESSAGE :

    迁移消息

MIGRATE_MESSAGE

filter

string

查询的过滤条件。

说明
  • 支持基于 operationKey,即 Topic 名称进行过滤

xx

instanceId

string

实例 ID。

rmq-cn-zxu37eiqq0x

pageNumber

integer

分页页码,查询第几页的返回结果。

1

pageSize

integer

分页大小,每页最多显示的返回结果数量。

10

返回参数

名称

类型

描述

示例值

object

Result<MyPage>

requestId

string

请求 ID

C7E8AE3A-219B-52EE-BE32-4036F5F88833

success

boolean

是否成功

true

data

object

返回结果

pageNumber

integer

当前页码

1

pageSize

integer

分页大小

10

totalCount

integer

总记录数

1

list

array<object>

分页数据

object

迁移操作列表。

operationId

integer

迁移操作 ID

183

migrationId

integer

迁移 ID

1

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

操作对象主键

说明
  • 在消息迁移阶段,操作对象为 Topic 名称

normal-topic-1

businessStatus

string

操作业务状态。

枚举值:

  • MIGRATE_WAIT :

    读写源集群

  • SWITCH_WRITE :

    写目标集群冗余读

  • MIGRATE_FINISH :

    读写目标集群

  • DOUBLE_READ :

    写源集群冗余读

  • ALREADY_MIGRATED :

    已迁移

DOUBLE_READ

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 00:00:00

updateTime

string

修改时间

2022-08-01 20:05:50

code

string

错误码

Instance.NotFound

message

string

错误信息

The topic already exists.

httpStatusCode

integer

HTTP 状态码

200

dynamicCode

string

动态错误码

InstanceId

dynamicMessage

string

动态错误信息

consumerGroupId

示例

正常返回示例

JSON格式

{
  "requestId": "C7E8AE3A-219B-52EE-BE32-4036F5F88833",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "operationId": 183,
        "migrationId": 1,
        "stageType": "MIGRATE_MESSAGE",
        "operationType": "MIGRATE_MESSAGE",
        "operationStatus": "DOING",
        "operationKey": "normal-topic-1",
        "businessStatus": "DOUBLE_READ",
        "operationParam": {
          "paramData": "{\n      \"action\": \"MIGRATE_FORWARD\",\n      \"targetStage\": \"MIGRATE_FINISH\"\n}"
        },
        "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 00:00:00",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "code": "Instance.NotFound",
  "message": "The topic already exists.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "consumerGroupId"
}

错误码

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

变更历史

更多信息,参考变更详情