文档首页/ 数据库和应用迁移 UGO/ API参考/ API/ 评估项目/ 创建评估项目
更新时间：2023-06-16 GMT+08:00
查看PDF
分享

创建评估项目

功能介绍

创建评估项目。评估项目分2个阶段：采集、评估。

URI

POST /v1/{project_id}/evaluation-projects

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token。
表3 请求Body参数

参数

是否必选

参数类型

描述

evaluation_project_name

是

String

评估项目名称。长度为5-50个字符，以英文字母开头，英文字母或数字结束，允许包含下划线和中划线。不允许重复。

最小长度：5

最大长度：50

source_db_info

是

表4 object

源库信息。

schemas_info

是

表5 object

源库中的schema信息。

objects_type_info

是

表6 object

源库中的对象类型信息。
表4 SourceDBInfo

参数

是否必选

参数类型

描述

connection_string

是

String

连接字符串。

user_name

是

String

用户名。

password

是

String

用户密码。

source_db_type

是

String

数据库类型。

枚举值：ORACLE

source_db_version

是

String

数据库版本。

注意：

该字段的值是数据库类型source_db_type对应的版本，当前支持以下组合： ORACLE-11g； ORACLE-12c； ORACLE-18c； ORACLE-19c。

枚举值：

  • 11g
  • 12c
  • 18c
  • 19c
表5 SchemaInfo

参数

是否必选

参数类型

描述

is_select_all_schemas

是

Boolean

是否选择全部schema。

schemas_list

否

Array of strings

需要评估的源库schema列表。is_select_all_schemas为false时，必填。
表6 ObjectTypeInfo

参数

是否必选

参数类型

描述

is_select_all_objects_type

是

Boolean

是否选择全部object类型。取值为true时，不包含USER。

objects_type_list

否

Array of strings

需要评估的object类型列表。is_select_all_objects_type为false时必填。

响应参数

无

请求示例

创建名为best_UGO，源库为Oracle-11g，采集全部schema和全部支持的数据类型的评估项目。

POST https://{endpoint}/v1/0ac6eb2c8000d2ee2fd9c006dededbe6/evaluation-projects 
 
{ 
  "evaluation_project_name" : "best_UGO", 
  "source_db_info" : { 
    "user_name" : "ugo", 
    "password" : "Ugo@123", 
    "connection_string" : "100.xx.xxx.xxx:1521:ORCL", 
    "source_db_type" : "ORACLE", 
    "source_db_version" : "11g" 
  }, 
  "schemas_info" : { 
    "is_select_all_schemas" : true, 
    "schemas_list" : [ ] 
  }, 
  "objects_type_info" : { 
    "is_select_all_objects_type" : true, 
    "objects_type_list" : [ ] 
  } 
}

响应示例

无

状态码

状态码

描述

201

请求成功。

错误码

请参见错误码。

父主题： 评估项目