Updated on 2023-05-29 GMT+08:00

Querying the Status of a Migration Project

Function

This API is used to query the status of a migration project.

URI

GET /v1/{project_id}/migration-projects/{migration_project_id}/status

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

migration_project_id

Yes

String

Migration project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

migration_project_id

Integer

Migration project ID.

migration_project_name

String

Migration project name.

evaluation_project_id

Integer

Evaluation project ID.

evaluation_project_name

String

Evaluation project name.

migration_project_status

String

Migration project status.

Value:

  • READY
  • NOT_READY

permission_check_status

String

Target database permission check status.

Valid value:

  • SUCCESS
  • FAILED
  • WAITING
  • PENDING
  • IGNORE

resource_id

String

Resource ID.

created_time

String

Creation time.

updated_time

String

Update time.

Example Request

Obtaining the status of a migration project

GET https://{endpoint}/v1/0ac6eb2c8000d2ee2fd9c006dededbe6/migration-projects/243/status

Example Response

Status code: 200

Request succeeded.

{ 
  "migration_project_id" : 243, 
  "migration_project_name" : "OPEN_API_MIGRATION", 
  "evaluation_project_id" : 191, 
  "evaluation_project_name" : "OPEN_API_EVALUATION", 
  "migration_project_status" : "READY", 
  "permission_check_status" : "SUCCESS", 
  "resource_id" : "28c045f5-7941-4a2c-85d2-8587334bcacc", 
  "created_time" : "2022-06-20T06:38:52Z", 
  "updated_time" : "2022-06-20T06:38:52Z" 
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

For details, see Error Codes.