Lacak Task Migration RocketMQ Berdasarkan Status via ListMigrations API - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

Mengkueri tugas migrasi.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

GET /migrations HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
filter	string	No	Kondisi filter untuk kueri.	xx
migrationType	string	Yes	Tipe migrasi: INSTANCE_MIGRATION: migrasi instans Valid values: INSTANCE_MIGRATION : Migrasi instans	INSTANCE_MIGRATION
pageNumber	integer	Yes	Nomor halaman hasil yang akan dikembalikan.	1
pageSize	integer	Yes	Jumlah entri yang akan dikembalikan per halaman.	10
resourceGroupId	string	No	ID grup sumber daya.	rg-acfm4goe2ckfiva

Elemen respons

Element	Type	Description	Example
	object	Result<MyPage>
requestId	string	ID permintaan.	E5897B2E-C3AC-56DC-A482-F0E9E53F48D5
success	boolean	Menunjukkan apakah permintaan berhasil.	true
data	object	Data yang dikembalikan.
pageNumber	integer	Nomor halaman saat ini.	1
pageSize	integer	Jumlah entri per halaman.	3
totalCount	integer	Jumlah total entri.	1
list	array<object>	Data pada halaman saat ini.
	array<object>	Daftar tugas migrasi.
migrationId	integer	The migration ID.	21
migrationName	string	The migration name.	xxx
migrationType	string	The migration type: INSTANCE_MIGRATION: instance migration	INSTANCE_MIGRATION
migrationStatus	string	The migration status: CREATED: Created MIGRATING: In progress COMPLETED: Complete CANCELLED: Canceled Valid values: CANCELLED : Canceled CREATED : Created COMPLETED : Complete MIGRATING : In progress	MIGRATING
userId	string	The user ID.	111
currentStage	object	The current migration stage.
stageType	string	The stage type. CONNECT_NETWORK: Network connection MIGRATE_METADATA: Metadata migration REPLACE_ENDPOINT: Endpoint replacement MIGRATE_MESSAGE: Message migration Valid values: REPLACE_ENDPOINT : Endpoint replacement MIGRATE_METADATA : Metadata migration CONNECT_NETWOR : Network connection MIGRATE_MESSAGE : Message migration	MIGRATE_METADATA
stageStatus	string	The stage status: INIT: Not started DOING: In progress DONE: Complete Valid values: INIT : Not started DONE : Complete DOING : In progress	DOING
stageData	any	The stage data.	[]
migrationSource	object	The migration source.
sourceType	string	The migration source type: EXTERNAL_INSTANCE: External instance INTERNAL_INSTANCE: Alibaba Cloud V5.0 instance Valid values: EXTERNAL_INSTANCE : External instance INTERNAL_INSTANCE : Alibaba Cloud V5.0 instance	EXTERNAL_INSTANCE
sourceData	any	The source data.	{ "clusterType":"INTERNET_NETWORK", "aclType":"NONE", "clusterName":"test", "namesrvAddrList":"47.110.248.xxx:9876"], "brokerObtainMethod":"AUTO_OBTAIN" }
migrationTarget	object	The migration target.
targetType	string	The migration target type: INTERNAL_INSTANCE: Alibaba Cloud V5.0 instance Valid values: INTERNAL_INSTANCE : Alibaba Cloud V5.0 instance	INTERNAL_INSTANCE
targetData	any	The target data.	{ "clusterType":"ROCKETMQ_V5", "instanceId":"rmq-cn-778429mp301", "regionId":"cn-hangzhou" }
createTime	string	The time when the task was created.	2022-08-01 00:00:00
updateTime	string	The time when the task was last updated.	2022-08-01 20:05:50
code	string	Kode kesalahan.	MissingInstanceId
message	string	Pesan kesalahan.	The instance cannot be found.
httpStatusCode	integer	Kode status HTTP.	200
dynamicCode	string	Kode kesalahan dinamis.	InstanceId
dynamicMessage	string	Pesan kesalahan dinamis.	instanceId

Contoh

Respons sukses

JSONformat

{
  "requestId": "E5897B2E-C3AC-56DC-A482-F0E9E53F48D5",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 3,
    "totalCount": 1,
    "list": [
      {
        "migrationId": 21,
        "migrationName": "xxx",
        "migrationType": "INSTANCE_MIGRATION",
        "migrationStatus": "MIGRATING",
        "userId": "111",
        "currentStage": {
          "stageType": "MIGRATE_METADATA",
          "stageStatus": "DOING",
          "stageData": "[]"
        },
        "migrationSource": {
          "sourceType": "EXTERNAL_INSTANCE",
          "sourceData": "{\n\"clusterType\":\"INTERNET_NETWORK\",\n\"aclType\":\"NONE\",\n\"clusterName\":\"test\",\n\"namesrvAddrList\":\"47.110.248.xxx:9876\"],\n\"brokerObtainMethod\":\"AUTO_OBTAIN\"\n}"
        },
        "migrationTarget": {
          "targetType": "INTERNAL_INSTANCE",
          "targetData": "{\n\"clusterType\":\"ROCKETMQ_V5\",\n\"instanceId\":\"rmq-cn-778429mp301\",\n\"regionId\":\"cn-hangzhou\"\n}"
        },
        "createTime": "2022-08-01 00:00:00",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.