All Products
Search

This Product

    ApsaraDB RDS:ModifyActiveOperationTasks

    Document Center

    ApsaraDB RDS:ModifyActiveOperationTasks

    Last Updated:Sep 13, 2024

    Changes the switching time of scheduled O\\\\\\&M tasks for an instance.

    Operation description

    Supported database engines

    • MySQL
    • PostgreSQL
    • SQL Server
    • MariaDB

    References

    Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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
    rds:ModifyActiveOperationTasksupdate
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    IdsstringYes

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

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

    The scheduled switching time that you want to specify. 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 that is specified by the SwitchTime parameter cannot be later than the time that is specified by the Deadline parameter. You can call the DescribeActiveOperationTasks operation to query the value of the Deadline parameter in the response.
    		2019-10-17T18:50:00Z
    ImmediateStartintegerNo

    Specifies whether to immediately start scheduling. Valid values:

    • 0 (default): no
    • 1: yes
    Note

    • If you set this parameter to 0, the SwitchTime parameter takes effect. If you set this parameter to 1, the SwitchTime parameter does not take effect. In this case, the start time of the task is the current time, and the system determines the switching time based on the start time.

    • Immediate scheduling specifies that the task enters the preparing state instead of being executed immediately. After the preparation is complete, the switchover is performed. You can call the DescribeActiveOperationTasks to query the preparation time that is returned for the PrepareInterval parameter.

    		0

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    Idsstring

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

    		11111,22222
    RequestIdstring

    The ID of the region.

    		E9ADB6BE-1598-57FC-B86D-D7F4C69B****

    Examples

    Sample success responses

    JSONformat

    {
  "Ids": "11111,22222",
  "RequestId": "E9ADB6BE-1598-57FC-B86D-D7F4C69B****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400StartTimeBeforeNowThe start time should be later than current time.The start time must be later than the current time.
    400RequiredParam.NotFoundRequired input param is not found.-
    400InvalidTime.FormatSpecified time is not valid.The time format is invalid.
    400TaskModifyErrorPart of the tasks cannot be modified.-
    400SwitchTimeAfterDeadlineThe switch time should be earlier than deadline.-
    400IncorrectTaskTypeCurrent task does not support this operation.-
    400TaskHasStartedTask has started.-
    400IncorrectTaskStatusThe status of certain task does not support this operation.-

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