Querying Migration Projects

Function

This API is used to query migration projects. After migration projects were created, you can call this API to obtain the project IDs based on project names.

URI

GET /v1/{project_id}/migration-projects

**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.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset of the pagination query. Minimum value: 0 Maximum value: 99 Default value: 0.
limit	No	Integer	Number of items displayed per page. Minimum value: 1 Maximum value: 100 Default value: 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
migration_projects	Array of Table 5 objects	Migration projects on the current page.
total_count	Integer	Total number of migration projects.

**Table 5** MigrationProject
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 migration projects

POST https://{endpoint}/v1/0ac6eb2c8000d2ee2fd9c006dededbe6/migration-projects?offset=0&limit=2

Example Response

Status code: 200

Request succeeded.

{ 
  "migration_projects" : [ { 
    "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" 
  }, { 
    "migration_project_id" : 242, 
    "migration_project_name" : "ugo_test", 
    "evaluation_project_id" : 191, 
    "evaluation_project_name" : "OPEN_API_EVALUATION", 
    "migration_project_status" : "READY", 
    "permission_check_status" : "SUCCESS", 
    "resource_id" : "19596ba7-8680-47dd-a67a-d567d7535601", 
    "created_time" : "2022-06-20T04:11:13Z", 
    "updated_time" : "2022-06-20T04:11:13Z" 
  } ], 
  "total_count" : 8 
}