文档

DescribeActiveOperationTasks - 查询多个主动运维任务信息

更新时间:

该接口用于查看RDS实例的计划内运维任务详情。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

授权信息

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

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

请求参数

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

待处理事件所属的地域 ID,可调用 DescribeRegions 接口获取。

说明 取值为 all 表示所有地域 ID。
cn-beijing
TaskTypestring

任务类型,取值:

  • rds_apsaradb_ha:主从节点切换。
  • rds_apsaradb_transfer:实例迁移。
  • rds_apsaradb_upgrade:小版本升级。
  • rds_apsaradb_maxscale: 代理小版本升级。
  • all:所有任务类型。
rds_apsaradb_upgrade
PageSizeinteger

每页记录数, 默认每页 25 条,最大 100。

25
PageNumberinteger

页码,大于 0, 默认 1。

1
ProductIdstring

产品名称, RDS/POLARDB/MongoDB/Redis,对于 RDS 实例可选 RDS。

RDS
DbTypestring

数据库类型,默认为 all 可选:mysql/pgsql/mssql 等

all
Statusinteger

任务状态,用于筛选返回任务。

  • -1:全部任务。
  • 3:待处理任务。
  • 4:处理中任务。
  • 5:成功结束任务。
  • 6:失败结束任务。
  • 7:已取消任务。
-1
InsNamestring

实例名,可不填,填写时只允许填写至多一个实例名。

rm-bp191w771kd3****
AllowChangeinteger

是否允许修改时间,默认-1,取值:

  • -1:全部。
  • 0:只返回不允许修改时间的任务。
  • 1:只返回允许修改时间的任务。
-1
AllowCancelinteger

是否允许取消,默认-1,取值:

  • -1:全部。
  • 0:只返回不允许取消的任务。
  • 1:只返回允许取消的任务。
-1
ChangeLevelstring

任务级别,默认为 all,取值:

  • all:全部
  • S0:返回异常修复级别的任务。
  • S1:返回系统运维级别的任务。
all

返回参数

名称类型描述示例值
object

返回参数详情。

PageNumberinteger

页码,大于 0, 默认 1。

1
RequestIdstring

请求 ID。

D4D4BE8A-DD46-440A-BFCD-EE31DA81****
PageSizeinteger

每页记录数, 默认每页 25 条,最大 100。

25
TotalRecordCountinteger

返回的任务记录数。

1
Itemsobject []

运维任务列表。

Statusinteger

任务状态。

  • 3:待处理任务。
  • 4:处理中任务。
  • 5:成功结束任务。
  • 6:失败结束任务。
  • 7:已取消任务。
3
ChangeLevelEnstring

事件等级(英文)。

System maintenance
TaskTypestring

任务类型,取值:

  • rds_apsaradb_ha:主从节点切换。
  • rds_apsaradb_transfer:实例迁移。
  • rds_apsaradb_upgrade:小版本升级。
  • rds_apsaradb_maxscale: 代理小版本升级。
rds_apsaradb_upgrade
InsNamestring

实例名。

rm-wz96h8jujh512****
Regionstring

待处理事件所属的地域 ID。

cn-beijing
ImpactZhstring

事件影响(中文)。

实例闪断
CreatedTimestring

创建时间,为 UTC 时间,格式为 YYYY-MM-DDTHH:mm:ssZ。

2018-05-30T14:30:00Z
SwitchTimestring

后台发起切换操作的时间点,为 UTC 时间,格式为 YYYY-MM-DDTHH:mm:ssZ。

2018-05-30T14:30:00Z
ChangeLevelZhstring

事件等级(中文)。

系统运维
Deadlinestring

任务执行时间可调整范围的最晚期限,为 UTC 时间,格式为 YYYY-MM-DDTHH:mm:ssZ。

2018-05-30T23:59:59Z
PrepareIntervalstring

开始时间到切换时间之间所需的准备时间, 格式为 HH:mm:ss。

04:00:00
Impactstring

事件影响。

TransientDisconnection
TaskTypeZhstring

任务原因中文。

小版本升级
CurrentAVZstring

当前可用区。

cn-beijing-h
AllowChangestring

是否允许修改时间,1 表示允许用户修改时间,0 表示不允许用户修改时间。

1
DbVersionstring

内核版本号。

5.7
ImpactEnstring

事件影响(英文)。

Transient instance disconnection
InsCommentstring

实例别名/实例备注。

test
StartTimestring

后台执行任务的时间点,为 UTC 时间,格式为 YYYY-MM-DDTHH:mm:ssZ。

2018-05-30T00:00:00Z
ModifiedTimestring

修改时间,为 UTC 时间,格式为 YYYY-MM-DDTHH:mm:ssZ。

2018-05-30T14:30:00Z
AllowCancelstring

是否允许取消,1 表示允许用户取消任务,0 表示不允许取消。

1
DbTypestring

数据库类型,如 mysql/pgsql/mssql。

mysql
ChangeLevelstring

事件等级代码,S1 系统运维 S0 风险修复。

S1
TaskTypeEnstring

任务原因英文。

Minor version update
ResultInfostring

执行结果信息。

userCancel
Idinteger

任务 ID。

11111
SubInsNamesarray

实例分片。

string

子任务名称。

sub1369716295573-tes2cy6****.2013052818****
TaskParamsstring

任务参数

{ "Action": "UpgradeDBInstance" }

示例

正常返回示例

JSON格式

{
  "PageNumber": 1,
  "RequestId": "D4D4BE8A-DD46-440A-BFCD-EE31DA81****",
  "PageSize": 25,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 3,
      "ChangeLevelEn": "System maintenance",
      "TaskType": "rds_apsaradb_upgrade",
      "InsName": "rm-wz96h8jujh512****",
      "Region": "cn-beijing",
      "ImpactZh": "实例闪断",
      "CreatedTime": "2018-05-30T14:30:00Z",
      "SwitchTime": "2018-05-30T14:30:00Z",
      "ChangeLevelZh": "系统运维",
      "Deadline": "2018-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00",
      "Impact": "TransientDisconnection",
      "TaskTypeZh": "小版本升级",
      "CurrentAVZ": "cn-beijing-h",
      "AllowChange": "1",
      "DbVersion": "5.7",
      "ImpactEn": "Transient instance disconnection",
      "InsComment": "test",
      "StartTime": "2018-05-30T00:00:00Z",
      "ModifiedTime": "2018-05-30T14:30:00Z",
      "AllowCancel": "1",
      "DbType": "mysql",
      "ChangeLevel": "S1",
      "TaskTypeEn": "Minor version update",
      "ResultInfo": "userCancel",
      "Id": 11111,
      "SubInsNames": [
        "sub1369716295573-tes2cy6****.2013052818****"
      ],
      "TaskParams": "{\n      \"Action\": \"UpgradeDBInstance\"\n}"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidPageParam.FormatPage param should be a positive integer.页码参数应该为正数。
400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。

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

变更历史

变更时间变更内容概要操作
2023-07-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈