Updated on 2023-06-16 GMT+08:00

Confirming the Target Database Type

Function

This API is used to confirm the target database type.

URI

POST /v1/{project_id}/evaluation-projects/target-confirmation

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.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

evaluation_project_id

Yes

String

Evaluation project ID.

target_db_type

Yes

String

Target database type.

target_db_version

Yes

String

Target database version.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

evaluation_project_id

Integer

Evaluation project ID.

evaluation_project_name

String

Evaluation project name.

evaluation_project_status

String

Evaluation project status.

Value:

  • COMPLETED
  • WAITING
  • PENDING
  • FAILED
  • STOPPED

project_status_detail

Table 5 object

Details about the evaluation project status.

source_db_type

String

Source database type.

source_db_version

String

Source database version.

target_db_type

String

Target database type.

target_db_version

String

Target database version.

Table 5 ProjectStatusDetail

Parameter

Type

Description

object_collection_status

String

Collection status.

object_collection_progress

String

Collection progress.

pre_migration_status

String

Evaluation status.

pre_migration_progress

String

Evaluation progress.

Example Request

Confirming the target database type of the evaluation project (whose ID is 230) is RDS for MySQL-5.7.

POST https://{Endpoint}/v1/0ac6eb2c8000d2ee2fd9c006dededbe6/evaluation-projects/target-confirmation 
 
{ 
  "evaluation_project_id" : 230, 
  "target_db_type" : "RDS for MySQL", 
  "target_db_version" : "5.7" 
}

Example Response

Status code: 200

Request succeeded.

{ 
  "evaluation_project_id" : "230", 
  "evaluation_project_name" : "best_UGO", 
  "evaluation_project_status" : "PENDING", 
  "project_status_detail" : { 
    "object_collection_status" : "COMPLETED", 
    "pre_migration_status" : "COMPLETED" 
  }, 
  "source_db_type" : "ORACLE", 
  "target_db_type" : "RDS for MySQL", 
  "target_db_version" : "5.7" 
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

For details, see Error Codes.