All Products
Search
Document Center

:ModifyActiveOperationTask

Last Updated:Nov 06, 2024

Changes the scheduled switchover time of an O\&M task.

Operation description

You can receive notifications for ApsaraDB for Redis events such as instance migration and version upgrade by text message, phone call, email, internal message, or by using the ApsaraDB for Redis console. You can also change the scheduled switchover time of a task in the ApsaraDB for Redis console. For more information, see Query or manage pending events.

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:
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:ModifyActiveOperationTaskupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdsstringYes

The ID of the O&M task. Separate multiple IDs with commas (,).

Note You can call the DescribeActiveOperationTask operation to query the ID of an O&M task.
11111,22222
SwitchTimestringYes

The scheduled switchover time to be specified. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Note The time cannot be later than the latest operation time. You can call the DescribeActiveOperationTask operation to obtain the latest operation time, which is the value of the Deadline parameter in the response.
2019-10-17T18:50:00Z

Response parameters

ParameterTypeDescriptionExample
object
Idsstring

The ID of the O&M task. IDs are separated by commas (,).

11111,22222
RequestIdstring

The ID of the request.

5D622714-AEDD-4609-9167-F5DDD3D1****

Examples

Sample success responses

JSONformat

{
  "Ids": "11111,22222",
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

Error codes

HTTP status codeError codeError messageDescription
400RequiredParam.NotFoundRequired input param is not found.Missing input parameter
400TaskModifyErrorPart of the tasks cannot be modified.-
400SwitchTimeAfterDeadlineThe switch time should be earlier than deadline.-
400StartTimeBeforeNowThe start time should not be earlier than the current time.-
403IncorrectTaskStatusCertain task's status does not support this operation.-

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

Change history

Change timeSummary of changesOperation
No change history