全部产品
Search

搜索本产品

    数据管理 DMS：GetDataCronClearConfig - 查询历史数据清理工单的定时配置

    文档中心

    数据管理 DMS：GetDataCronClearConfig - 查询历史数据清理工单的定时配置

    更新时间：Nov 06, 2024

    查询历史数据清理工单的定时配置。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dms:GetDataCronClearConfigget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    OrderIdlong是

    工单 ID，可通过调用接口 ListOrders 获取该参数的值。

    		51****
    Tidlong否

    租户 ID。

    说明 取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。
    		3***

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求 ID。

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

    请求是否成功，返回值如下：

    • true：请求成功。
    • false：请求失败。
    		true
    ErrorMessagestring

    调用失败时，返回的错误信息。

    		UnknownError
    ErrorCodestring

    错误码。

    		UnknownError
    DataCronClearConfigobject

    数据配置。

    CronFormatstring

    Crontab 表达式，以便定期执行任务。更多信息，请参见 Crontab 表达式。

    		0 0 23 ? * 7,1
    Durationstring

    执行时长（单位：小时）。取值为 0 时，说明不指定执行时长。

    		1
    CronStatusstring

    定时任务状态，为空表示未调度，其他取值及说明如下：

    • PAUSE：调度暂停。
    • WAITING：待调度。
    • SUCCESS：调度完成。
    		SUCCESS
    CronCallTimesstring

    调度次数。

    		2
    CronLastCallStartTimestring

    最近一次调度时间。

    		2022-11-18 00:00:00
    CronNextCallTimestring

    下一次调度时间。

    说明 仅当调度状态为 SUCCESS 时才会显示。
    		2022-11-19 00:00:00
    OptimizeTableAfterEveryClearTimeslong

    是否启用自动 Optimize table，取值：

    • 0：不启用。
    • 大于 0：启用，表示每隔多少次清理以后下次调用进行 Optimize table。
    		0
    CurrentClearTaskCountlong

    已进行自动 Optimize table 的次数，仅当 OptimizeTableAfterEveryClearTimes 大于 0 时有效。

    		0

    示例

    正常返回示例

    JSON格式

    {
  "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
  }
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史