调用DescribeTasks获取任务列表_云原生数据库 PolarDB-阿里云帮助中心

查看通过API生成的任务（如创建集群）进度详情。

接口说明

支持查看直接使用某API（如CreateDBCluster）生成的任务，或在PolarDB控制台使用某功能（如创建集群）时，系统调用了对应API生成的任务进度详情。
当前仅支持查看创建集群时，即调用CreateDBCluster接口且CreationOption参数值不为CreateGdnStandby时，生成的任务进度详情。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeTasks	READ	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	否	集群ID。说明 `DBNodeId`和`DBClusterId`必选其一填入。您可以通过DescribeDBClusters接口查看账号下所有集群的详细信息，包括集群ID。	pc-***************
DBNodeId	string	否	节点ID。说明 `DBNodeId`和`DBClusterId`必选其一填入。您可以通过DescribeDBClusters接口查看账号下所有集群的详细信息，包括节点ID。	pi-***************
StartTime	string	是	查询开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。	2020-11-30T00:00Z
EndTime	string	是	查询结束时间，查询结束时间需晚于开始时间，格式为`YYYY-MM-DDThh:mmZ`（UTC时间）。	2020-12-02T03:00Z
Status	string	否	任务状态，取值范围如下： Waiting：任务等待执行中 Running：任务正在执行中 Finished：任务已完成 Closed：任务已关闭 Pause：任务已暂停 Stop：任务已中断说明若该参数留空，仅返回当前集群或节点下所有状态为Waiting或Running的任务详情。支持输入多个任务状态，各状态之间用逗号分割查询。	Running
PageSize	integer	否	每页记录数，取值为30、50或100。默认值为30。	30
PageNumber	integer	否	页码，取值为大于0且不超过Integer数据类型的最大值。默认值为1。	1

返回参数

名称	类型	描述	示例值
	object
TotalRecordCount	integer	总记录数。	1
PageRecordCount	integer	本页记录数。	30
Tasks	object []	任务详情。
FinishTime	string	任务完成时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。	2020-12-02T02:40:15Z
StepsInfo	string	任务子步骤详情。	[{\"remain\":0,\"name\":\"init_task\",\"progress\":100},{\"remain\":1764,\"name\":\"create_instance\",\"progress\":0},{\"remain\":1,\"name\":\"init_cluster\",\"progress\":0},{\"remain\":2,\"name\":\"create_backup\",\"progress\":0}]
Progress	integer	任务进度百分比。	100
ExpectedFinishTime	string	预计结束时间。若无特殊情况，该参数为空。	null
BeginTime	string	任务开始时间，格式为`YYYY-MM-DDThh:mm:ssZ`（UTC时间）。	2020-12-02T02:39:15Z
TaskErrorCode	string	任务出错时的错误码。说明仅当任务状态为Stop时返回该参数。	null
ProgressInfo	string	任务进度的描述信息。若目标任务无进度描述信息，该参数为空。	null
CurrentStepName	string	当前任务的子步骤名称。	create_instance
StepProgressInfo	string	任务子步骤进度。例如`1/4`表示该任务共包含4个子步骤，当前正在执行第一步。	1/4
TaskErrorMessage	string	任务出错时的错误信息。说明仅当任务状态为Stop时返回该参数。	null
TaskAction	string	目标任务所使用的API接口，例如`CreateDBInstance`。	CreateDBInstance
DBName	string	数据库名称。说明仅涉及数据库相关操作的任务会返回该参数。	test
Remain	integer	任务预计剩余时间，单位为秒。	1767
TaskId	string	目标任务ID。	111111111
EndTime	string	查询结束时间。	2020-12-02T03:00Z
RequestId	string	请求ID。	4352AD99-9FF5-41A6-A319-068089******
PageNumber	integer	页码。	1
StartTime	string	查询开始时间。	2020-11-30T00:00Z
DBClusterId	string	任务所对应的集群ID。	pc-***************

示例

正常返回示例

JSON格式

{
  "TotalRecordCount": 1,
  "PageRecordCount": 30,
  "Tasks": {
    "Task": [
      {
        "FinishTime": "2020-12-02T02:40:15Z",
        "StepsInfo": "[{\\\"remain\\\":0,\\\"name\\\":\\\"init_task\\\",\\\"progress\\\":100},{\\\"remain\\\":1764,\\\"name\\\":\\\"create_instance\\\",\\\"progress\\\":0},{\\\"remain\\\":1,\\\"name\\\":\\\"init_cluster\\\",\\\"progress\\\":0},{\\\"remain\\\":2,\\\"name\\\":\\\"create_backup\\\",\\\"progress\\\":0}]",
        "Progress": 100,
        "ExpectedFinishTime": "null",
        "BeginTime": "2020-12-02T02:39:15Z",
        "TaskErrorCode": "null",
        "ProgressInfo": "null",
        "CurrentStepName": "create_instance",
        "StepProgressInfo": "1/4",
        "TaskErrorMessage": "null",
        "TaskAction": "CreateDBInstance",
        "DBName": "test",
        "Remain": 1767,
        "TaskId": "111111111"
      }
    ]
  },
  "EndTime": "2020-12-02T03:00Z",
  "RequestId": "4352AD99-9FF5-41A6-A319-068089******",
  "PageNumber": 1,
  "StartTime": "2020-11-30T00:00Z",
  "DBClusterId": "pc-***************"
}

错误码

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