文档

CreateDataCronClearOrder - 创建历史数据清理工单

更新时间:

创建历史数据清理工单。

接口说明

目前仅支持安全协同管控模式的 MySQL 实例调用该接口。

关于该功能的更多说明,请参见历史数据清理

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Commentstring

业务背景,以减少沟通成本。

test
RelatedUserListarray

相关人列表。

long

相关人 ID,设置的相关人员可查看工单,并协同工作,非相关人员则不能查看工单(管理员、DBA 除外)。

243253
Paramobject

工单参数。

Classifystring

数据变更原因。

test
DbItemListobject []

变更的数据库列表。

DbIdlong

数据库 ID,可调用 SearchDatabases 接口获取。

10****
Logicboolean

是否为逻辑库,取值:

  • true:是
  • false:否
false
CronFormatstring

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

0 0 2 * * ?
CronClearItemListobject []

待清理的数据表列表。

TableNamestring

表名,您可以调用 ListTables 接口获取该参数。

t1
ColumnNamestring

字段名。

gmt_create
RemainDayslong

保留时长,即历史数据清理的规则,单位为天。例如您配置为 7 天,DMS 将在执行时删除 7 天前的数据。

7
TimeUnitstring

时间精度类型,当选择字段为日期数值型存储时使用,取值:

  • MILLISECONDS:毫秒
  • SECONDS:秒
MILLISECONDS
FilterSQLstring

过滤条件。

where 1 = 1
specifyDurationboolean

是否指定执行时长,取值:

  • true:指定执行时长,到达指定时间后即停止执行。
  • false:不指定执行时长,直到清理结束。
true
DurationHourlong

执行时长,单位为小时。

说明 specifyDuration 参数为 true 时,该参数必填。
4
AttachmentKeystring

工单补充附件,对本次操作进行补充说明。

您可以调用 GetUserUploadFileJob 接口获取该参数。

order_attachement.txt
Tidlong

租户 ID。

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

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Successboolean

请求是否成功。

true
ErrorMessagestring

错误信息。

UnknownError
ErrorCodestring

错误码。

UnknownError
CreateOrderResultarray

工单创建结果。

long

工单号。

1341532

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    1341532
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈