You need to enable JavaScript to run this app.
文档中心
云服务器

云服务器

复制全文
下载 pdf
镜像
DescribeTasks - 查询请求进度
复制全文
下载 pdf
DescribeTasks - 查询请求进度
调用 DescribeTasks 接口,查询一个或多个异步请求的进度。​
请求说明​
  • 支持查询创建、导入、导出及复制自定义镜像的任务进度,包括任务ID、状态、起止时间等。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeTasks​
要执行的操作,取值:DescribeTasks。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
MaxResults integer 可选 示例值:20​
分页查询时设置的每页行数:​
  • 最大值:100​
  • 默认值:20​
​
NextToken string 可选 示例值:3tiegs1y963vj0******​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
ResourceId string 可选 示例值:image-ebgy1og99tfct0gw​
资源ID。​
说明​
为提高兼容性,请使用ResourceIds.N参数。​
​
ResourceIds.N string[] 可选 示例值:ResourceIds.1=image-ebgy1og99tfc****&ResourceIds.2=image-opisd1og89tfc****​
资源ID,单次最多支持100个资源ID。​
  • 参数 - N:表示任务的序号。​
  • 多个资源ID之间用&分隔。​
​
TaskIds.N string[] 可选 示例值:TaskIds.1=t-ybnz9qci2sahiqdl****&TaskIds.2=t-ybnz9qci89sw*****​
任务ID,单次最多支持100个任务ID。您可以在调用ExportImage、CopyImage接口等操作自定义镜像时获取。​
  • 参数 - N:表示任务的序号。​
  • 多个任务ID之间用&分隔。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
NextToken string 示例值:bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******​
本次调用返回的查询凭证值,返回为空表示该页为末页。​
​
Tasks object[] 示例值:--​
任务列表。​
CreatedAt string 示例值:2022-05-06T00:01:00+08:00​
任务创建时间。​
​
EndAt string 示例值:2022-05-06T00:01:00+08:00​
任务结束时间。​
说明​
如果任务未结束,则此字段为空。​
​
Id string 示例值:t-ybnz9qci2sahiqdl****​
任务ID。​
​
Process long 示例值:100​
任务的进度,用百分数表示,单位为%。​
​
ResourceId string 示例值:image-ebgy1og99tfct0gw****​
资源ID。​
​
Status string 示例值:Succeeded​
任务的状态。取值:​
  • Pending:等待执行​
  • Running:运行中​
  • Succeeded:成功​
  • Failed:失败​
​
Type string 示例值:ExportImage​
待查询任务的类型。取值:​
  • ImportImage:导入自定义镜像​
  • ExportImage:导出自定义镜像​
  • CreateImage:创建自定义镜像​
  • CopyImage:复制自定义镜像​
说明​
复制自定义镜像为邀测功能,如需试用,请联系客户经理申请。​
​
UpdatedAt string 示例值:2022-05-06T00:01:00+08:00​
任务更新时间。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeTasks&Version=2020-04-01 HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202106111445100102252431000052****",​
"Action": "DescribeTasks",​
"Version": "2020-04-01",​
"Service": "ecs",​
"Region": "cn-beijing"​
},​
"Result": {​
"NextToken": "",​
"Tasks": [​
{​
"Id": "t-ybnz9qci2sahiqdl****",​
"CreatedAt": "2022-05-06T00:01:00+08:00",​
"UpdatedAt": "2022-05-06T00:07:12+08:00",​
"EndAt": "2022-05-06T00:07:12+08:00",​
"ResourceId": "image-ybnz9qci2sahiqdl****",​
"Type": "ExportImage",​
"Process": 100,​
"Status": "Succeeded"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
LimitExceeded.MaximumMaxResults​
The number of specified MaxResults exceeds the maximum limit.​
指定的MaxResults超过最大限制。​
400​
LimitExceeded.MaximumResourceIds​
You've reached the limit on the number of ResourceIds that you can set.​
指定的资源ID数量超过限制。​
400​
LimitExceeded.MinimumMaxResults​
The number of specified MaxResults exceeds the minimum limit.​
指定的MaxResults超过最小限制。​
400​
LimitExceeded.MaximumTaskIds​
You've reached the limit on the number of TaskIds that you can set.​
指定的任务ID数量超过限制。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2025.09.04 16:02:53
这个页面对您有帮助吗?
有用
有用
无用
无用