接口功能介绍
查询对象存储评估任务详情
接口约束
支持的线上资源池 ：华东1
URI
GET /v4/zms/get-evaluation-detail
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 81f7728xxxxx0155d307d5b | |
| evaluationID | 是 | String | 评估任务ID | 111_eva_c9axxxxx263d4518afb |
请求参数
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | Object | 响应对象 | 参考表result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| evaluationName | String | 评估任务名称 | mr-hcz | |
| evaluationID | String | 评估任务ID | 111_eva_c9axxxxx263d4518afb | |
| evaluationStatus | String | 评估任务当前状态，①waiting：排队中；②executing：评估中；③stopped：暂停；④finished：评估结束；⑤failed：评估失败 | waiting | |
| sourceInfo | Object | 源端信息 | 参考表sourceInfo | |
| destinationInfo | Object | 目的端信息 | 参考表destinationInfo | |
| taskProgress | Object | 当前任务进度 | 参考表taskProgress | |
| regionID | String | 资源池ID | 81f7728xxxxx0155d307d5b |
表 sourceInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| sourceType | String | 评估迁移源类型，①S3：亚马逊；②OSS：阿里云； ③COS：腾讯云；④ OBS：华为云；⑤ OOS：天翼云⑥ZOS：天翼云对象存储 | ZOS | |
| sourceEndpoint | String | 评估迁移资源池地址 | http://xxx:8888或https://xxx | |
| sourceBucket | String | 评估迁移源桶 | bucket-kpblz | |
| sourceBucketType | String | 评估源资源池迁移模式，①Bucket：整桶迁移；②Folder：文件夹迁移；③Prefix：前缀迁移 | Bucket | |
| evaluationFolder | String | 指定源资源池迁移的文件夹，仅当sourceBucketType为Folder时有效，其余场景显示为空 | folder | |
| evaluationPrefix | String | 指定源资源池迁移的前缀，仅当sourceBucketType为Prefix时有效，其余场景显示为空 | prefix |
表 destinationInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| destinationType | String | 目的端类型，目前默认为ZOS | ZOS |
表 taskProgress
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| scannedObjects | Integer | 已经扫描的对象数量 | 1234 | |
| objectSizeDistribution | Array of Objects | 对象大小分布 | 参考表objectSizeDistribution | |
| evaluationEstimatedCount | Integer | 评估迁移对象数量。若当前评估任务未结束，则显示为null（评估结果仅作参考） | 123 |
表 objectSizeDistribution
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| sizeRange | String | 对象大小的取值范围，①0；②0-100K；③100-500K；④500K-1M；⑤1-10M；⑥10-100M；⑦100-500M；⑧500M-1G；⑨大于1G | 100-500K | |
| currentCount | Integer | 当前范围内的对象数 | 100 |
枚举参数
无
请求示例
请求url
GET https://zos-global.ctapi.ctyun.cn/v4/zms/get-evaluation-detail?regionID=81f7728662d0155d307d5b&evaluationID=111_eva_c9aa6c6f56e2f263d4518afb
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"results": {
"regionID": "81f7728662d810800155d307d5b",
"evaluationStatus": "finished",
"evaluationID": "111_eva_c9aa6c6ab672f263d4518afb",
"destinationInfo": {
"destinationType": "ZOS"
},
"evaluationName": "buyaoshanchu",
"taskProgress": {
"objectSizeDistribution": [
{
"currentCount": 1,
"sizeRange": "0"
}
],
"evaluationEstimatedCount": 1,
"scannedObjects": 1
},
"sourceInfo": {
"sourceType": "ZOS",
"sourceEndpoint": "https://xxxx",
"evaluationFolder": "",
"sourceBucket": "asd",
"evaluationPrefix": "",
"sourceBucketType": "Bucket"
}
}
},
"details": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
