現時此頁面僅用英語顯示，繁體中文內容正在準備中。感謝您的耐心等待。

首頁Tair (Redis® OSS-Compatible)Developer ReferenceAPI integrationAPI ReferenceAPI catalogEvent managementDescribeActiveOperationTasks
搜尋幫助內容

DescribeActiveOperationTasks

更新時間：2025-03-11 05:30
產品
社區

Queries the O\\\\\\&M event details of an instance.

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.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:DescribeActiveOperationTasksget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
RegionstringNo

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.
cn-shanghai
TaskTypestringNo

The type of the O&M event. If this parameter is not specified, all types of O&M events are queried.

Valid values:

  • rds_apsradb_upgrade: minor version update
  • rds_apsaradb_ha: primary/secondary switchover
  • rds_apsaradb_ssl_update: SSL certificate update
  • rds_apsaradb_major_upgrade: major version upgrade
  • rds_apsradb_transfer: instance migration
  • rds_apsaradb_modify_config: network upgrade
  • rds_apsaradb_modify_config: instance parameter adjustment
  • rds_apsaradb_maxscale: proxy minor version update
all
PageSizeintegerNo

The number of entries per page. Default value: 25. Maximum value: 100.

25
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
ProductIdstringNo

The name of the service. Valid values: RDS, POLARDB, MongoDB, and Redis. For Redis instances, set the value to Redis.

Redis
DbTypestringNo

The database type. Valid values: redis

redis
StatusintegerNo

The status of an O&M event. This parameter is used to filter returned tasks. Valid values:

  • -1: filters all events.
  • 3: filters pending events.
  • 4: filters in-progress events.
  • 5: filters successful events.
  • 6: filters failed events.
  • 7: filters canceled events.
3
InsNamestringNo

The name of the instance. You can leave this parameter empty. If you configure this parameter, you can specify the name only of one instance.

r-wz96fzmpvpr2qnqnlb
AllowChangeintegerNo

The filter condition that is used to return events based on the settings of the switching time. Default value: -1. Valid values:

  • -1: returns all events.
  • 0: returns only O&M events for which the switching time cannot be changed.
  • -1: returns only O&M events for which the switching time can be changed.
-1
AllowCancelintegerNo

The filter condition that is used to return events based on the settings of event cancellation. Default value: -1. Valid values:

  • -1: returns all events.
  • 0: returns only O&M events that cannot be canceled.
  • 1: returns only O&M events that can be canceled.
1
ChangeLevelstringNo

The type of task configuration change. Valid values:

  • all (default): The configurations of all O&M tasks are changed.
  • S0: The configurations of tasks initiated to fix exceptions are changed.
  • S1: The configurations of system O&M tasks are changed.
all

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
PageNumberinteger

The page number.

1
RequestIdstring

The request ID.

2D9F3768-EDA9-4811-943E-42C8006E****
PageSizeinteger

The number of entries returned per page. Default 25.

25
TotalRecordCountinteger

The number of O&M events returned.

1
Itemsarray<object>

The list of O&M events.

Itemsobject

Details about the O&M event.

Statusinteger

The status of the O&M event. Valid values:

  • 3: filters pending events.
  • 4: filters in-progress events.
  • 5: filters successful events.
  • 6: filters failed events.
  • 7: filters canceled events.
5
ChangeLevelEnstring

The level of the task in English.

System maintenance
TaskTypestring

The type of the O&M event.

rds_apsaradb_transfer
InsNamestring

The instance ID.

r-bp1lgal1sdvxrz****
Regionstring

The region ID of the instance.

cn-hanghzou
ImpactZhstring

The impact of the task in Chinese.

CreatedTimestring

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-05-30T14:30:00Z
SwitchTimestring

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-05-30T14:30:00Z
ChangeLevelZhstring

The level of the task in Chinese.

Deadlinestring

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-05-30T23:59:59Z
PrepareIntervalstring

The required preparation period between the task start time and the switchover time. The time is displayed in the HH:mm:ss format.

04:00:00
TaskTypeZhstring

The reason for the task in Chinese.

CurrentAVZstring

The current zone.

cn-beijing-h
AllowChangestring

Indicates whether the switching time can be changed. The value 1 indicates that the switching time can be changed. The value 0 indicates that the switching time cannot be changed.

1
DbVersionstring

The version of the database engine.

5.0
ImpactEnstring

The impact of the task in English.

Transient instance disconnection
InsCommentstring

The alias and description of the instance.

test
StartTimestring

The time when the event is executed in the backend. The time must be in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.

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

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-05-30T14:30:00Z
AllowCancelstring

Indicates whether the event can be canceled. The value 1 indicates that the event can be canceled. The value 0 indicates that the event cannot be canceled.

1
DbTypestring

The database type of the instance. The return value is Redis.

redis
ChangeLevelstring

The code of the task level. The value S1 indicates the system O&M level. The value S0 indicates the exception fixing level.

S1
TaskTypeEnstring

The cause of the O&M event.

Minor version update
ResultInfostring

The information about the execution result.

userCancel
Idinteger

The ID of the O&M event.

11111
SubInsNamesarray

The list of sub-events.

SubInsNamesstring

The name of the sub-event.

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

The O&M event parameters.

{ "Action": "UpgradeDBInstance" }
Impactstring

The impact of the task.

TransientDisconnection

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "2D9F3768-EDA9-4811-943E-42C8006E****",
  "PageSize": 25,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 5,
      "ChangeLevelEn": "System maintenance\n",
      "TaskType": "rds_apsaradb_transfer",
      "InsName": "r-bp1lgal1sdvxrz****",
      "Region": "cn-hanghzou",
      "ImpactZh": "",
      "CreatedTime": "2018-05-30T14:30:00Z\n",
      "SwitchTime": "2018-05-30T14:30:00Z\n",
      "ChangeLevelZh": "",
      "Deadline": "2018-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00\n",
      "TaskTypeZh": "",
      "CurrentAVZ": "cn-beijing-h\n",
      "AllowChange": "1",
      "DbVersion": "5.0",
      "ImpactEn": "Transient instance disconnection",
      "InsComment": "test",
      "StartTime": "2018-05-30T00:00:00Z\n",
      "ModifiedTime": "2018-05-30T14:30:00Z\n",
      "AllowCancel": "1",
      "DbType": "redis",
      "ChangeLevel": "S1",
      "TaskTypeEn": "Minor version update",
      "ResultInfo": "userCancel",
      "Id": 11111,
      "SubInsNames": [
        "sub1369716295573-tes2cy6****.2013052818****\n"
      ],
      "TaskParams": "{\n      \"Action\": \"UpgradeDBInstance\"\n}",
      "Impact": "TransientDisconnection"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
No change history
上一篇：Event management下一篇：ModifyActiveOperationTasks
  • 本頁導讀 （1）
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
文檔反饋