接口功能介绍
查询对象存储评估任务列表
接口约束
支持的线上资源池 :华东1
URI
GET /v4/zms/list-evaluation
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 332232exxxxxxxxx2e5123866f0 | |
searchName | 否 | String | 模糊搜索评估任务名称 | my | |
pageNo | 否 | Integer | 页码,默认值为1 | 2 | |
pageSize | 否 | Integer | 页大小,默认值 10,取值范围 1~50 | 3 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中/失败) | 800 | |
message | String | 状态描述 | SUCCESS | |
returnObj | Object | 响应对象 | 参考表returnObj | |
description | String | 状态描述,一般为中文 | 成功 | |
errorCode | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码 | openapi.userPermission.accessFailed | |
error | String | 业务细分码(大驼峰形式,仅失败时具有此参数),为 Product.Module.Code 三段式码 | Openapi.UserPermission.AccessFailed |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
results | Array of Objects | 响应对象 | 参考表results | |
totalCount | Integer | 总数量 | 5 | |
pageNo | Integer | 当前页码 | 1 | |
currentCount | Integer | 当前页数量 | 2 | |
pageSize | Integer | 当前页展示数量 | 10 |
表 results
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
evaluationName | String | 评估任务名称 | mr-hcz | |
regionID | String | 资源池ID | 81f7728xxxxx0155d307d5b | |
sourceType | String | 迁移源类型,①S3:亚马逊;②OSS:阿里云; ③COS:腾讯云;④ OBS:华为云;⑤ OOS:天翼云⑥ZOS:天翼云对象存储 | ZOS | |
destinationType | String | 目的端类型,目前均为ZOS | ZOS | |
evaluationID | String | 评估任务ID | 222_eva_a0d60xxxxxxdbeb0213362217328 | |
evaluationStatus | String | 评估任务当前状态,①waiting:排队中;②executing:评估中;③stopped:暂停;④finished:评估结束;⑤failed:评估失败 | waiting | |
evaluationCreateTime | String | 评估任务创建时间 | 2024-12-11 10:44:56 | |
evaluationCompleteTime | String | 评估任务完成时间。若当前评估任务未结束,则显示为null | 2024-12-11 10:47:48 | |
evaluationEstimatedCount | Integer | 评估结果,为预估迁移对象数量。若当前评估任务未结束,则显示为null(评估结果仅作参考) | 1 |
枚举参数
无
请求示例
请求url
GET https://zos-global.ctapi.ctyun.cn/v4/zms/list-evaluation?regionID=81f7728xxxxx0155d307d5b&searchName=a&pageNo=1&pageSize=10
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"pageSize": 10,
"results": [
{
"evaluationCreateTime": "2024-12-11 10:44:56",
"evaluationStatus": "finished",
"sourceType": "ZOS",
"evaluationCompleteTime": "2024-12-11 10:47:48",
"destinationType": "ZOS",
"evaluationID": "111_eva_c9axxxxx263d4518afb",
"regionID": "81f7728xxxxx0155d307d5b",
"evaluationName": "buyaoshanchu",
"evaluationEstimatedCount": 1
}
],
"pageNo": 1
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码