DescribeScheduleTasks_云数据库 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.

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
Statusstring

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

示例值:finish
DBClusterIdstring

集群 ID。展开详情

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

地域 ID。展开详情

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
PageNumberinteger<int32>

页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1

示例值:1
PageSizeinteger<int32>

每页记录数,取值为 30(默认值)、50100

示例值:30
TaskActionstring

任务类型,取值范围如下:展开详情

示例值:CreateDBNodes参考取值来源:
    DescribeTasks
DBClusterDescriptionstring

集群描述。

示例值:testdb
OrderIdstring

订单 ID。展开详情

示例值:20951253014****
PlannedStartTimestring

为目标任务设定的执行开始时间(UTC 时间)。

示例值:2021-01-28T12:00Z
PlannedEndTimestring

为目标任务设定的最晚开始时间(UTC 时间)。

示例值:2021-01-28T12:30Z
ResourceGroupIdstring

资源组 ID。

示例值:rg-************

返回参数

字段名称字段详情
Dataobject

结果集。

Messagestring

请求返回消息。展开详情

示例值:Successful
RequestIdstring

请求 ID。

示例值:936C7025-27A5-4CB1-BB31-540E1F0CCA12
Successboolean

请求结果。

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidOrderId.Malformed
The specified parameter OrderId is not valid.诊断

变更历史

变更时间变更内容概要操作
2024-09-26
变更返回参数
2024-08-29
变更返回参数
2023-09-12
新增错误码400
2022-08-24
新增请求参数ResourceGroupId
2022-07-13
新增请求参数PlannedStartTime
新增请求参数PlannedEndTime
2021-11-04
变更返回参数
2021-08-12
新增请求参数DBClusterDescription
新增请求参数OrderId