Updated on 2026-08-10 GMT+08:00

Querying the Migration

Function

This API is used to query the migration result.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v3/migrates

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

all_regions

No

Boolean

Definition

Whether to query the migration results in other regions.

Constraints

N/A

Range

  • true: triggers migration.

  • false: does not trigger migration.

Default Value

true

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

status

String

Definition

Tenant migration status.

Range

  • success

  • failed

  • migrating

project_status

Array of DomainMigrateProjectStatus objects

Project migration status

Table 3 DomainMigrateProjectStatus

Parameter

Type

Description

status

String

Definition

Tenant migration status.

Range

  • success

  • failed

  • migrating

project_id

String

Definition

Project ID.

Range

N/A

project_name

String

Definition

Project name.

Range

N/A

region_id

String

Definition

Region ID.

Range

N/A

progress

Integer

Definition

Migration progress.

Range

0–100

fail_code

Integer

Definition

Error code. This parameter appears only when the project status is failed.

Range

N/A

fail_reason

String

Definition

Failure cause. This parameter appears only when the project status is failed.

Range

N/A

Example Requests

GET https://{endpoint}/v3/migrates

Example Responses

Status code: 200

OK

{
  "status" : "failed",
  "project_status" : [ {
    "status" : "failed",
    "progress" : 1,
    "project_id" : "fe1431a61f4242dd87e548f8f42ec0b4",
    "project_name" : "cn-north-7",
    "region_id" : "cn-north-7",
    "fail_code" : 4002,
    "fail_reason" : "An error occurred when converting models: dictionary keys changed during iteration."
  }, {
    "status" : "success",
    "progress" : 100,
    "project_id" : "bccd81411c254e6890fe88d2f2ce406b",
    "project_name" : "cn-north-7-virtual",
    "region_id" : "cn-north-7"
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.