全部产品
Search
文档中心

云备份:DescribeTask - 查询异步任务

更新时间:Dec 26, 2024

查询一个异步任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hbr:DescribeTaskget
*全部资源
*

请求参数

名称类型必填描述示例值
Tokenstring

凭证 Token 内容。

01W3ZZOQ
TaskIdstring

任务 ID。

t-*********************
ResourceGroupIdstring

资源组 ID。

rg-acfmvywqfey5njq

返回参数

名称类型描述示例值
object
Progressinteger

任务进度。取值范围为 0~100,单位为百分比(%)。任务失败时直接返回-1。

100
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
CompletedTimelong

任务完成时间。UNIX 时间戳,单位秒。

1615607706
Resultstring

任务结果。

{}
Descriptionstring

任务状态。取值范围:

  • created:任务已创建。
  • expired:任务已过期。
  • completed:任务已完成。
  • cancelled:任务已取消。
completed
UpdatedTimelong

任务更新时间。UNIX 时间,单位秒。

1615607706
Successboolean

请求是否成功。

  • true:成功
  • false:失败
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
Namestring

任务名称。

InstallBackupClientsTask
CreatedTimelong

任务创建时间。UNIX 时间,单位秒。

1615607706

示例

正常返回示例

JSON格式

{
  "Progress": 100,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "CompletedTime": 1615607706,
  "Result": "{}",
  "Description": "completed",
  "UpdatedTime": 1615607706,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Name": "InstallBackupClientsTask",
  "CreatedTime": 1615607706
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史