All Products
Search

This Product

    Data Management:GetDataCronClearConfig

    Document Center

    Data Management:GetDataCronClearConfig

    Last Updated:Oct 21, 2024

    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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    OrderIdlongYes

    The ID of the ticket. You can call the ListOrders operation to query the ticket ID.

    		420****
    TidlongNo

    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

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The ID of the request.

    		283C461F-11D8-48AA-B695-DF092DA32AF3
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		true
    ErrorMessagestring

    The error message returned if the request failed.

    		UnknownError
    ErrorCodestring

    The error code.

    		UnknownError
    DataCronClearConfigobject

    Data configuration.

    CronFormatstring

    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
    Durationstring

    The execution duration of the task. Unit: hours. If the value is 0, it indicates the duration is not specified.

    		1
    CronStatusstring

    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
    CronCallTimesstring

    The number of times that the task is run.

    		2
    CronLastCallStartTimestring

    The time when the task was last run.

    		2022-11-18 00:00:00
    CronNextCallTimestring

    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
    OptimizeTableAfterEveryClearTimeslong

    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
    CurrentClearTaskCountlong

    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 timeSummary of changesOperation
    No change history