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

创建历史数据清理工单。

接口说明

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

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateDataCronClearOrder

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Comment	string	是	业务背景，以减少沟通成本。	test
RelatedUserList	array	否	相关人列表。
	integer	否	相关人 ID，设置的相关人员可查看工单，并协同工作，非相关人员则不能查看工单（管理员、DBA 除外）。	243253
Param	object	是	工单参数。
Classify	string	否	数据变更原因。	test
DbItemList	array<object>	是	变更的数据库列表。
	object	否	数据库信息。
DbId	integer	是	数据库 ID，可调用 SearchDatabases 接口获取。	10****
Logic	boolean	是	是否为逻辑库，取值： true：是 false：否	false
CronFormat	string	是	Crontab 表达式，以便定期执行任务，更多信息，请参见 Crontab 表达式。	0 0 2 * * ?
CronClearItemList	array<object>	是	待清理的数据表列表。
	object	否	待清理的数据表信息。
TableName	string	是	表名，您可以调用 ListTables 接口获取该参数。	t1
ColumnName	string	是	字段名。字段为日期类型。	gmt_create
RemainDays	integer	是	保留时长，即历史数据清理的规则，单位为天。例如您配置为 7 天，DMS 将在执行时删除 7 天前的数据。	7
TimeUnit	string	否	时间精度类型，当选择字段为日期数值型存储时使用，取值： MILLISECONDS：毫秒 SECONDS：秒	MILLISECONDS
FilterSQL	string	否	过滤条件。	where 1 = 1
specifyDuration	boolean	是	是否指定执行时长，取值： true：指定执行时长，到达指定时间后即停止执行。 false：不指定执行时长，直到清理结束。	true
DurationHour	integer	否	执行时长，单位为小时。说明当 specifyDuration 参数为 true 时，该参数必填。	4
AttachmentKey	string	否	工单补充附件，对本次操作进行补充说明。您可以调用 GetUserUploadFileJob 接口获取该参数。	order_attachement.txt
Tid	integer	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	123454324

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	请求是否成功。	true
ErrorMessage	string	错误信息。	UnknownError
ErrorCode	string	错误码。	UnknownError
CreateOrderResult	array	工单创建结果。
	integer	工单号。	1341532

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。