GetDataCronClearConfig - Data Management - Alibaba Cloud Documentation Center

Queries the scheduling configuration of a ticket for cleaning up historical data.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetDataCronClearConfig	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the ticket. You can call the ListOrders operation to query the ticket ID.	420****
Tid	long	No	The ID of the tenant. Note : To view the ID of the tenant, go 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 parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	283C461F-11D8-48AA-B695-DF092DA32AF3
Success	boolean	Indicates 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	Data configuration.
CronFormat	string	The crontab expression that you can use to run 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. If the value is 0, it indicates the duration is not specified.	1
CronStatus	string	The status of the scheduled task. If this parameter is empty, it indicates the task is not run. Valid values: PAUSE: The task is suspended. WAITING: The task is waiting to be run. SUCCESS: The task is complete.	PAUSE
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 time when the task is run next time. This parameter is displayed only when the status of the scheduled task is SUCCESS.	2022-11-19 00:00:00
OptimizeTableAfterEveryClearTimes	long	Specifies whether to enable automatic execution of the OPTIMIZE TABLE statement. 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	long	The number of times that the Optimize Table statement is automatically exeuted. This parameter is valid only when the value of the OptimizeTableAfterEveryClearTimes parameter is greater than 0.	0

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history