调用CreateDataCronClearOrder创建历史数据清理工单。

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

目前仅支持MySQL实例调用该接口。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDataCronClearOrder

系统规定参数。取值:CreateDataCronClearOrder

Comment String test

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

RelatedUserList Array of Long 243253

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

Param Object

工单参数。

Classify String test

数据变更原因。

DbItemList Array

变更的数据库列表。

DbId Long 10****

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

Logic Boolean false

是否为逻辑库,取值:

  • true:是
  • false:否
CronFormat String 0 0 2 * * ?

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

CronClearItemList Array

待清理的数据表列表。

TableName String t1

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

ColumnName String gmt_create

字段名。

RemainDays Long 7

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

TimeUnit String MILLISECONDS

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

  • MILLISECONDS:毫秒
  • SECONDS:秒
FilterSQL String where 1 = 1

过滤条件。

specifyDuration Boolean true

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

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

执行时长,单位为小时。

说明specifyDuration参数为true时,该参数必填。
AttachmentKey String order_attachement.txt

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

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

Tid Long 123454324

租户ID。

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

选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明

说明 请根据应用所在地就近选择。

返回数据

名称 类型 示例值 描述
RequestId String 0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

请求ID。

Success Boolean true

请求是否成功。

ErrorMessage String UnknownError

错误信息。

ErrorCode String UnknownError

错误码。

CreateOrderResult Array of Long 1341532

工单号。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=CreateDataCronClearOrder
&Comment=test
&RelatedUserList=[243253]
&Param={"Classify":"test","DbItemList":[{"DbId":10****,"Logic":false}],"CronFormat":"0 0 2 * * ?","CronClearItemList":[{"TableName":"t1","ColumnName":"gmt_create","RemainDays":7,"TimeUnit":"MILLISECONDS","FilterSQL":"where 1 = 1"}],"specifyDuration":true,"DurationHour":4}
&AttachmentKey=order_attachement.txt
&Tid=123454324
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateDataCronClearOrderResponse>
    <RequestId>0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931</RequestId>
    <Success>true</Success>
    <CreateOrderResult>1341532</CreateOrderResult>
</CreateDataCronClearOrderResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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