GetDataCronClearConfig API Reference for Historical Data Cleanup - Data Management - Alibaba Cloud - Data Management

Queries the scheduling configuration of a historical data cleanup ticket.

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

dms:GetDataCronClearConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the ticket. You can call the ListOrders operation to query the ticket ID.	51****
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, log on to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.	3***

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	283C461F-11D8-48AA-B695-DF092DA32AF3
Success	boolean	Whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ErrorCode	string	The error code.	UnknownError
DataCronClearConfig	object	The scheduling configuration for historical data cleanup.
CronFormat	string	The crontab expression for running the task at a specified time. For more information, see Crontab expression.	0 0 23 ? * 7,1
Duration	string	The execution duration of the task. Unit: hours. A value of 0 indicates the duration is not specified.	1
CronStatus	string	The status of the scheduled task. An empty value indicates the task has not been run. Valid values: PAUSE: The task is suspended. WAITING: The task is waiting to be run. SUCCESS: The task is complete.	SUCCESS
CronCallTimes	string	The number of times that the task is run.	2
CronLastCallStartTime	string	The time when the task was last run.	2022-11-18 00:00:00
CronNextCallTime	string	The next scheduled run time. Returned only when CronStatus is SUCCESS.	2022-11-19 00:00:00
OptimizeTableAfterEveryClearTimes	integer	Whether automatic execution of the OPTIMIZE TABLE statement is enabled. Valid values: 0: disables automatic execution A number greater than 0: enables automatic execution. The number specifies the number of times that cleanup operations must be performed before the OPTIMIZE TABLE statement is automatically executed.	0
CurrentClearTaskCount	integer	The number of times that the OPTIMIZE TABLE statement has been automatically executed. Valid only when OptimizeTableAfterEveryClearTimes is greater than 0.	0

Examples

Success response

JSON format

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DataCronClearConfig": {
    "CronFormat": "0 0 23 ? * 7,1",
    "Duration": "1",
    "CronStatus": "SUCCESS",
    "CronCallTimes": "2",
    "CronLastCallStartTime": "2022-11-18 00:00:00",
    "CronNextCallTime": "2022-11-19 00:00:00",
    "OptimizeTableAfterEveryClearTimes": 0,
    "CurrentClearTaskCount": 0
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.