接口功能介绍
创建对象存储评估任务
接口约束
1、支持的线上资源池 :华东1
2、单个用户可创建最多5个任务
URI
POST /v4/zms/create-evaluation
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池 ID | 332232eb-63aa-465e-9028-52e5123866f0 | |
evaluationName | 是 | String | 任务名称,必须为大小写字母、数字、横线或下划线,长度在4-32个字符之间,且名称不能重复 | mr-hcz | |
sourceInfo | 是 | Array of Objects | 源端信息 | 参考表sourceInfo | |
destinationInfo | 否 | Array of Objects | 目的端信息 | 参考表destinationInfo |
表 sourceInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sourceType | 否 | String | 评估迁移源类型,默认为S3,①S3:亚马逊;②OSS:阿里云; ③COS:腾讯云;④ OBS:华为云;⑤ OOS:天翼云⑥ZOS:天翼云对象存储 | S3 | |
sourceEndpoint | 是 | String | 评估迁移资源池地址,支持输入IP或域名,以https://或http://开头。如需使用非默认端口,请输入端口号 | http://xxx:8888或https://xxx | |
sourceBucket | 是 | String | 评估迁移源桶,输入限制不超过1024字符 | bucket-kpblz | |
sourceAccessKey | 是 | String | 评估迁移源资源池ak,输入限制不超过1024字符 | XXXXXX | |
sourceSecretKey | 是 | String | 评估迁移源资源池sk,输入限制不超过1024字符 | XXXXXX | |
sourceBucketType | 否 | String | 评估源资源池迁移模式,默认为Bucket。①Bucket:整桶迁移;②Folder:文件夹迁移;③Prefix:前缀迁移 | Bucket | |
evaluationFolder | 否 | String | 指定源资源池迁移的文件夹,仅当sourceBucketType为Folder时有效,当前仅支持指定单个文件夹,单个文件夹名输入限制不超过1024字符 | folder1 | |
evaluationPrefix | 否 | String | 指定源资源池迁移的前缀,仅当sourceBucketType为Prefix时有效,当前只支持指定单个前缀,单个前缀名输入限制不超过1024字符 | prefix1 |
表 destinationInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
destinationType | 否 | String | 目的端类型,目前默认且仅支持ZOS | ZOS |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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 | String | 任务结果 | success | |
evaluationID | String | 评估任务ID,作为其他操作(详情、开始、暂停、恢复、删除)参数中的evaluationID传入 | xxx |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "xxxxxxxxxxxxxxxxxxxx",
"evaluationName":"buyaosha",
"sourceInfo":[{
"sourceType":"ZOS",
"sourceEndpoint":"https://xxxx",
"sourceBucket":"asdf",
"sourceAccessKey":"xxxxx",
"sourceSecretKey":"xxxxxxxxxxxx",
"sourceBucketType":"Bucket",
"evaluationFolder":"",
"evaluationPrefix":""
}],
"destinationInfo":[{
"destinationType":"ZOS"
}]
}
响应示例
{
"returnObj":
{
"result": "success",
"evaluationID": "222_eva_a0d60xxxxxxdbeb0213362217328"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码