You need to enable JavaScript to run this app.
文档中心
存储迁移服务

存储迁移服务

复制全文
下载 pdf
openapi
GetTask - 获取任务
复制全文
下载 pdf
GetTask - 获取任务
调用 GetTask 接口获取任务。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:GetTask​
要执行的操作,取值:GetTask。​
​
Version string 必选 示例值:2025-01-01​
API的版本,取值:2025-01-01。​
​
Id string 必选 示例值:1*​
任务 ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Id string 示例值:1*​
任务 ID。​
​
AccountId string 示例值:210000****​
账号 ID。​
​
TaskName string 示例值:task-name​
任务名称。​
​
TaskType string 示例值:HalfManaged​
任务类型,取值说明:​
HalfManaged:半托管类型。​
​
TaskStatus string 示例值:Transferring​
任务状态,取值说明如下:​
  • Queueing:查询中​
  • Preparing:准备中​
  • Transferring:转移中​
  • Verifying:验证中​
  • Finished:已完成​
  • Stopping:停止中​
  • Stopped:己停止​
  • Failing:失败中​
  • Failed:己失败​
​
SourceId string 示例值:1*​
源端地址 ID。​
​
DestinationId string 示例值:1*​
目标端地址 ID。​
​
AgentGroupId string 示例值:1*​
代理组 ID。​
​
TaskConfig object 示例值:-​
任务配置。​
StorageClassDirective string 示例值:Standard​
迁移的对象在目标端的存储类型,取值说明如下:​
  • Standard:标准存储。​
  • InheritSource:继承源端存储类型。​
  • Ia:低频存储。​
  • ArchiveFr:归档闪回存储。​
  • IntelligentTiering:智能分层存储。​
  • ColdArchive:冷归档存储。​
  • Archive:归档存储。​
  • DeepColdArchive:深度冷归档。​
​
ListConfig object 示例值:-​
任务列举参数配置。​
ListIncludePrefixes string[] 示例值:[prefix1,prefix2]​
需要迁移的前缀列表,多个前缀用英文逗号(,)隔开。​
​
ListIncludeBeginTime string 示例值:1766974902040​
开始时间,任务会迁移修改时间大于该时间的对象,毫秒时间戳。​
​
ListIncludeEndTime string 示例值:1766974902040​
结束时间,任务会迁移修改时间早于该时间的对象。​
​
GenerateReport boolean 示例值:true​
是否生成报告。​
​
ListIncludeBucketKeys object 示例值:-​
清单配置信息。​
Bucket string 示例值:test​
存储桶名称。​
​
Ak string 示例值:AKLTYWFkMGU0Yj****​
访问目标端对象存储的 Access Key ID。​
​
Sk string 示例值:T1RkbVpHTm****​
访问目标端对象存储的 Secret Access Key。​
​
Keys string[] 示例值:[objectname1,objectname2]​
清单文件对象名列表,多个对象名用英文逗号(,)隔开。​
​
​
​
SymlinkPolicy string 示例值:follow​
软链接文件迁移策略,取值说明如下:​
  • skip:不迁移软链接文件。​
  • follow:将软链接文件以独立文件的形式迁移到对象存储 TOS。​
​
OverwritePolicy string 示例值:Force​
迁移任务覆盖策略,取值说明如下:​
  • Force:针对同名文件,不做任何判断,直接用源端覆盖目的端。​
  • None:针对同名文件,不做任何判断,直接跳过。​
  • LastModify:当源端和目标端出现同名文件时,根据文件的 lastmodify 字段(最后修改时间)判断是否进行覆盖,仅当源端文件的最后修改时间晚于目的端文件最后修改时间时执行覆盖。​
​
​
CreateAt string 示例值:1766974902040​
创建时间,毫秒时间戳。​
​
UpdateAt string 示例值:1766974902040​
更新时间,毫秒时间戳。​
​
TaskContext object 示例值:-​
任务执行信息。​
ErrorCode string 示例值:1003-00000001​
错误码,即错误响应对应的 HTTP 消息返回码。​
​
ErrorMessage string 示例值:do list objects on source failed​
错误信息,即错误响应消息中具体错误详细的英文描述。​
​
​
​
​
请求示例​
​
GET /?Action=GetTask&Version=2025-01-01&Id=1* HTTP/1.1​
Host: dms.cn-beijing.volcengineapi.com​
X-Date: 20251009T084935Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251009/cn-beijing/dms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20251009164940040067218161046F88",​
"Action": "GetTask",​
"Version": "2025-01-01",​
"Service": "dms",​
"Region": "cn-beijing"​
},​
"Result": {​
"Id": "1*",​
"AccountId": "210000****",​
"TaskName": "task-name",​
"TaskType": "HalfManaged",​
"TaskStatus": "Transferring",​
"SourceId": "1*",​
"DestinationId": "1*",​
"AgentGroupId": "1*",​
"CreateAt": "1766974902040",​
"UpdateAt": "1766974902040",​
"TaskContext": {}​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
2002-00000012​
InvalidRequestBody​
参数错误。​
404​
2002-00000014​
EntityNotFoundErr​
对应实体不存在。​
500​
2001-00000001​
ServiceInternalErr​
服务端异常,请稍后重试。​
​
​
最近更新时间:2026.01.27 18:52:33
这个页面对您有帮助吗?
有用
有用
无用
无用