DescribeTasks_云数据库 PolarDB_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求参数

字段名称字段详情
DBClusterIdstring

集群 ID。展开详情

示例值:pc-***************参考取值来源:
    ModifyDBCluster
    CreateDBCluster
    DescribeDBClusters
    TransformDBClusterPayType
    RestartDBLink
    EnableDBClusterServerless
    DisableDBClusterServerless
DBNodeIdstring

节点 ID。展开详情

示例值:pi-***************参考取值来源:
    TempModifyDBNode
    CreateDBNodes
StartTimestring

查询开始时间,格式为YYYY-MM-DDThh:mmZ(UTC 时间)。

示例值:2020-11-30T00:00Z
EndTimestring

查询结束时间,查询结束时间需晚于开始时间,格式为YYYY-MM-DDThh:mmZ(UTC 时间)。

示例值:2020-12-02T03:00Z
Statusstring

任务状态,取值范围如下:展开详情

示例值:Running
PageSizeinteger<int32>

每页记录数,取值为 3050100展开详情

示例值:30
PageNumberinteger<int32>

页码,取值为大于 0 且不超过 Integer 数据类型的最大值。展开详情

示例值:1

返回参数

字段名称字段详情
TotalRecordCountinteger<int32>

总记录数。

示例值:1
PageRecordCountinteger<int32>

本页记录数。

示例值:30
Tasksobject
EndTimestring

查询结束时间。

示例值:2020-12-02T03:00Z
RequestIdstring

请求 ID。

示例值:4352AD99-9FF5-41A6-A319-068089******
PageNumberinteger<int32>

页码。

示例值:1
StartTimestring

查询开始时间。

示例值:2020-11-30T00:00Z
DBClusterIdstring

任务所对应的集群 ID。

示例值:pc-***************

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidDBNodeId.Malformed
The specified parameter DBNodeId is not valid.诊断
400
InvalidStartTime.Malformed
The specified parameter StartTime is not valid.诊断
400
InvalidEndTime.Malformed
The specified parameter EndTime is not valid.诊断
400
InvalidPageSize.Malformed
The specified parameter PageSize is not valid.诊断
400
InvalidPageNumber.Malformed
The specified parameter PageNumber is not valid.诊断
400
InvalidStatus.Malformed
The specified parameter Status is not valid.诊断

变更历史

变更时间变更内容概要操作
2023-09-12
新增错误码400