调用DescribeActiveOperationTask查询Redis实例的运维任务详情。

调用本接口查询到当前有运维任务后,您还可以调用ModifyActiveOperationTask修改运维任务的计划切换时间。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeActiveOperationTask

系统规定参数,取值:DescribeActiveOperationTask

Region String all

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

说明 取值为all表示所有地域ID。
TaskType String all

任务类型,取值:

  • rds_apsaradb_ha:主从节点切换。
  • rds_apsaradb_transfer:实例迁移。
  • rds_apsaradb_upgrade:小版本升级。
  • all:所有任务类型。
RegionId String cn-hangzhou

地域ID,可调用DescribeRegions接口获取。

IsHistory Integer 1

是否返回历史任务,取值:

  • 0:默认值,返回当前任务。
  • 1:返回历史任务。
PageSize Integer 30

每页可展示的最大记录数,取值需大于10,默认值为30

PageNumber Integer 1

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

返回数据

名称 类型 示例值 描述
Items Array of Items

运维任务列表。

CreatedTime String 2018-07-15 23:59:59

运维任务的创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

DbType String redis

数据库类型,返回值:redis

Deadline String 2018-07-19 23:59:59

运维任务执行时间可调整范围的最晚期时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Id Integer 114111

运维任务ID。

InsName String r-bp1lgal1sdvxrz****

Redis实例ID。

ModifiedTime String 2018-07-19 14:00:00

运维任务修改时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

PrepareInterval String 14:00:00

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

Region String cn-hanghzou

地域ID。

StartTime String 2018-07-19 10:00:00

运维任务执行的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Status Integer 5

任务状态,返回值:

  • 2:等待用户指定时间。
  • 3:等待处理。
  • 4:处理中(此状态下不可调用XXX接口修改时间)。
  • 5:成功。
  • 6:失败。
  • 7:已取消。
SwitchTime String 2018-07-19 14:00:00

系统发起的切换操作的时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

TaskType String rds_apsaradb_upgrade

任务类型,返回值:

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

页码。

PageSize Integer 30

每页可展示的最大记录数。

RequestId String 2E1FF0CC-F42A-4B6F-A1F4-A17B1451****

请求ID。

TotalRecordCount Integer 1

总记录数。

示例

请求示例

http(s)://https://r-kvstore.aliyuncs.com/?Action=DescribeActiveOperationTask
&Region=all
&TaskType=all
&<公共请求参数>

正常返回示例

XML 格式

<DescribeActiveOperationTaskResponse>
      <TotalRecordCount>1</TotalRecordCount>
      <RequestId>2E1FF0CC-F42A-4B6F-A1F4-A17B1451****</RequestId>
      <PageSize>30</PageSize>
      <PageNumber>1</PageNumber>
      <Items>
            <Status>5</Status>
            <CreatedTime>2019-10-17T20:28:31Z</CreatedTime>
            <Deadline>2019-10-21T15:59:59Z</Deadline>
            <StartTime>2019-10-17T17:50:00Z</StartTime>
            <InsName>r-bp1lgal1sdvxrz****</InsName>
            <DbType>redis</DbType>
            <ModifiedTime>2019-10-17T20:28:31Z</ModifiedTime>
            <TaskType>rds_apsaradb_upgrade</TaskType>
            <PrepareInterval>01:00:00</PrepareInterval>
            <Region>cn-hangzhou</Region>
            <Id>114111</Id>
            <SwitchTime>2019-10-17T18:50:00Z</SwitchTime>
      </Items>
</DescribeActiveOperationTaskResponse>

JSON 格式

{
	"TotalRecordCount": 1,
	"RequestId": "2E1FF0CC-F42A-4B6F-A1F4-A17B1451****",
	"PageSize": 30,
	"PageNumber": 1,
	"Items": [
		{
			"Status": 5,
			"CreatedTime": "2019-10-17T20:28:31Z",
			"Deadline": "2019-10-21T15:59:59Z",
			"StartTime": "2019-10-17T17:50:00Z",
			"InsName": "r-bp1lgal1sdvxrz****",
			"DbType": "redis",
			"ModifiedTime": "2019-10-17T20:28:31Z",
			"TaskType": "rds_apsaradb_upgrade",
			"PrepareInterval": "01:00:00",
			"Region": "cn-hangzhou",
			"Id": 114111,
			"SwitchTime": "2019-10-17T18:50:00Z"
		}
	]
}

错误码

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