DescribeActiveOperationTask - Tair (Redis® OSS-Compatible)

Queries the detailed information about O\&M tasks of an ApsaraDB for Redis instance.

Operation description

After you have called this API operation and queried the information about a specific O&M task, you can also call the ModifyActiveOperationTask operation to modify the scheduled switchover time of the O&M task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeActiveOperationTask	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region ID of the O&M task. You can call the DescribeRegions operation to query the most recent region list. Note A value of all indicates all region IDs.	all
TaskType	string	Yes	The type of the O&M task. Valid values: rds_apsaradb_ha: master-replica switchover rds_apsaradb_transfer: instance migration rds_apsaradb_upgrade: minor version update	all
IsHistory	integer	No	Specifies whether to return the historical tasks. Default value: 0. Valid values: 0: returns the current task. 1: returns the historical tasks.	1
PageSize	integer	No	The number of entries to return on each page. Specify a value greater than 10. Default value: 30.	30
PageNumber	integer	No	The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	2E1FF0CC-F42A-4B6F-A1F4-A17B1451****
PageSize	integer	The maximum number of entries returned per page.	30
TotalRecordCount	integer	The total number of returned entries.	1
Items	array<object>	Details of O&M tasks.
Items	object
Status	integer	The state of the O&M task. Valid values: 2: The task is waiting for users to specify a switchover time. 3: The task is waiting to be performed. 4: The task is being performed. If the task is in this state, the ModifyActiveOperationTask operation cannot be called to modify the scheduled switchover time. 5: The task is performed. 6: The task fails. 7: The task is canceled.	5
Deadline	string	The deadline before which the time to preform the O&M task can be modified. The time in UTC is displayed in the yyyy-MM-ddTHH:mm:ssZ format.	2018-07-19 23:59:59
PrepareInterval	string	The required preparation period between the task start time and the switchover time. The time is displayed in the HH:mm:ss format.	14:00:00
TaskType	string	The type of the task. Valid values: rds_apsaradb_ha: master-replica switchover rds_apsaradb_transfer: instance migration rds_apsaradb_upgrade: minor version update all: all types	rds_apsaradb_upgrade
StartTime	string	The time when the O&M task was preformed. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-07-19 10:00:00
ModifiedTime	string	The time when the O&M task was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-07-19 14:00:00
InsName	string	The ID of the instance.	r-bp1lgal1sdvxrz****
DbType	string	The database type of the instance. The return value is Redis.	redis
Region	string	The region ID of the instance.	cn-hanghzou
CreatedTime	string	The time when the O&M task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-07-15 23:59:59
Id	integer	The ID of the O&M task.	114111
SwitchTime	string	The time when the system performs the switchover operation. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-07-19 14:00:00

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "2E1FF0CC-F42A-4B6F-A1F4-A17B1451****",
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 5,
      "Deadline": "2018-07-19 23:59:59",
      "PrepareInterval": "14:00:00",
      "TaskType": "rds_apsaradb_upgrade",
      "StartTime": "2018-07-19 10:00:00",
      "ModifiedTime": "2018-07-19 14:00:00",
      "InsName": "r-bp1lgal1sdvxrz****",
      "DbType": "redis",
      "Region": "cn-hanghzou",
      "CreatedTime": "2018-07-15 23:59:59",
      "Id": 114111,
      "SwitchTime": "2018-07-19 14:00:00"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	RequiredParam.NotFound	Required input param is not found.	Missing input parameter

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history