調用ExecuteMigrationOperation API對訊息遷移任務執行指定操作-雲訊息佇列 RocketMQ 版-阿里雲 - ApsaraMQ for RocketMQ

指定的遷移任務執行指定的操作。

調試

您可以在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
stageType	string	是	遷移階段類型。枚舉值： MIGRATE_MESSAGE : 訊息遷移	MIGRATE_MESSAGE
operationId	integer	是	遷移操作 ID	2729

請求參數

名稱	類型	必填	描述	樣本值
instanceId	string	否	執行個體 ID。	rmq-cn-x0r37kel***
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
operationStatus	string	操作狀態。枚舉值： INIT : 未開始 DONE : 已完成 DOING : 執行中 FAIL : 已失敗	DOING
operationKey	string	操作對象主鍵	normal-topic-1
businessStatus	string	操作業務狀態。枚舉值： 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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。