查询评估项目列表

功能介绍

查询评估项目列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/evaluation-projects

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一Region下的Project ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
evaluation_project_name	否	String	评估项目名称（模糊搜索）。
evaluation_project_status	否	String	评估项目状态。枚举值： COMPLETED 完成 PENDING 进行 FAILED 失败 STOPPED 停止
offset	否	Integer	分页查询的偏移量。最小值：0 最大值：99 缺省值：0
limit	否	Integer	每页显示的条目数量。最小值：1 最大值：100 缺省值：10

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total_count	Integer	评估项目总数。
evaluation_projects	Array of 表5 objects	当前页的评估项目列表。

表5 EvaluationProject
参数	参数类型	描述
evaluation_project_id	Integer	评估项目ID。
evaluation_project_name	String	评估项目名称。
evaluation_project_status	String	评估项目状态。枚举值： COMPLETED 完成 PENDING 进行 FAILED 失败 STOPPED 停止
project_status_detail	表6 object	评估项目状态详情。
source_db_type	String	源数据库类型。枚举值： Oracle MySQL GoldenDB PostgreSQL Microsoft SQL Server Informix MariaDB openGauss
source_db_version	String	源数据库版本。枚举值： Oracle： 10g、11g、12c、18c、19c、21c MySQL 5.5、5.6、5.7、8.0 Microsoft SQL Server： 2012、2014、2016、2017、2019、2022 Informix: 11、12 MariaDB： 10.6 openGauss： 1.0、2.0、3.0、4.0、5.0、6.0、7.0
target_db_type	String	目标数据库类型。枚举值： GaussDB Centralized GaussDB Distributed GaussDB CloudNative(Centralized) GaussDB CloudNative(Distributed) GaussDB Centralized(M-Compatibility) GaussDB Centralized(B-Compatibility) GaussDB Distributed(MySQL-Compatibility) RDS for PostgreSQL RDS for MySQL TaurusDB
target_db_version	String	目标数据库版本。 GaussDB Centralized 10.0、9.0、8.200、8.100、8.0、3.3、3.2、3.1、2.7 GaussDB Distributed 9.0、8.200、8.100、8.0、3.3、3.2、3.1、2.7 GaussDB CloudNative(Centralized) 10.0 GaussDB CloudNative(Distributed) 10.0 GaussDB Centralized(M-Compatibility) 10.0、9.0、8.200、8.100 GaussDB Centralized(B-Compatibility) 10.0、8.200、8.100、8.0、3.3、3.2、3.1、2.7 GaussDB Distributed(MySQL-Compatibility) 10.0、8.200、8.100、8.0、3.3、3.2、3.1、2.7 RDS for PostgreSQL 11、12、13、14、15 RDS for MySQL 5.7 TaurusDB
collect_size	Long	已收集的SQL大小，单位：B。
resource_id	String	资源ID。
created_time	String	创建时间。
updated_time	String	更新时间。
error_reason	String	失败原因。

表6 ProjectStatusDetail
参数	参数类型	描述
object_collection_status	String	采集的状态。枚举值： true false
object_collection_progress	String	采集的进度。
pre_migration_status	String	评估的状态。枚举值： COMPLETED 完成 WAITING 等待 PENDING 进行 FAILED 失败 STOPPED 停止
pre_migration_progress	String	评估的进度。

请求示例

获取评估项目列表。

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

响应示例

状态码： 200

请求成功。

{ 
  "evaluation_projects" : [ { 
    "evaluation_project_id" : 187, 
    "evaluation_project_name" : "ugo_best", 
    "evaluation_project_status" : "PENDING", 
    "project_status_detail" : { 
      "object_collection_status" : "COMPLETED", 
      "pre_migration_status" : "COMPLETED" 
    }, 
    "source_db_type" : "ORACLE", 
    "source_db_version" : "11g", 
    "target_db_version" : "", 
    "collect_size" : 4623291, 
    "resource_id" : "826c916c-421d-4d9f-a68c-38bc3a9504ad", 
    "created_time" : "2022-06-23T03:34:39Z", 
    "updated_time" : "2022-06-23T03:34:39Z", 
    "error_reason" : "" 
  }, { 
    "evaluation_project_id" : 129, 
    "evaluation_project_name" : "ugo1_best", 
    "evaluation_project_status" : "PENDING", 
    "project_status_detail" : { 
      "object_collection_status" : "COMPLETED", 
      "pre_migration_status" : "COMPLETED" 
    }, 
    "source_db_type" : "ORACLE", 
    "source_db_version" : "11g", 
    "target_db_version" : "", 
    "collect_size" : 2914875, 
    "resource_id" : "c98da3c4-7afb-4b62-85f3-c8cb5f2393ef", 
    "created_time" : "2022-06-21T06:58:18Z", 
    "updated_time" : "2022-06-21T06:58:18Z", 
    "error_reason" : "" 
  } ], 
  "total_count" : 3 
}