調用CreateDataCronClearOrder建立定期歷史資料清理工單-Data Management-阿里雲

建立歷史資料清理工單。

介面說明

目前僅支援安全協同管控模式的 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
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。