Modify the switching time of scheduled O&M tasks using ModifyActiveOperationTasks - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:ModifyActiveOperationTasks

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Ids	string	Yes	The IDs of the O&M tasks. Separate multiple task IDs with commas (,). Note You can call the DescribeActiveOperationTask operation to query the IDs of O&M tasks.	11111,22222
SwitchTime	string	Yes	The scheduled switching time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note The SwitchTime value cannot be later than the Deadline value. You can call the DescribeActiveOperationTasks operation to query the latest switching time returned for the Deadline parameter.	2019-10-17T18:50:00Z
ImmediateStart	integer	No	Specifies whether to start scheduling immediately. Valid values: 0 (default): Do not start scheduling immediately. 1: Start scheduling immediately. Note If you set this parameter to 0, the SwitchTime parameter takes effect. If you set this parameter to 1, SwitchTime does not take effect. The start time of the task is set to the current time, and the system determines the switching time based on the start time. Immediate scheduling means the task enters the preparing state, not that it is executed immediately. After preparation is complete, the switchover is performed. You can call the DescribeActiveOperationTasks operation to query the preparation time returned for the PrepareInterval parameter.	0
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmyiu4ekp****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Ids	string	The IDs of the O&M tasks. Multiple task IDs are separated by commas (,).	11111,22222
RequestId	string	The request ID.	CAAE9DDA-65FD-584C-A378-F1F24676****

Examples

Success response

JSON format

{
  "Ids": "11111,22222",
  "RequestId": "CAAE9DDA-65FD-584C-A378-F1F24676****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.