調用CreateDataArchiveOrder API建立資料歸檔工單-Data Management-阿里雲

使用此API可以建立資料歸檔工單，將資料歸檔至專屬儲存、RDS MySQL等目標中。

介面說明

僅安全協同的資料庫執行個體可調用此 API。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:CreateDataArchiveOrder

create

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Comment	string	是	任務描述資訊。	業務測試
Tid	integer	否	租戶 ID，可通過調用介面 GetUserActiveTenant 或 ListUserTenants 擷取該參數的值。	3***
PluginType	string	否	外掛程式類型資訊，預設為 DATA_ARCHIVE。	DATA_ARCHIVE
RelatedUserList	array	否	相關使用者列表。
	string	否	工單相關人 ID。	123***
ParentId	integer	否	父工單 ID。建立子工單時才會有父工單。	896****
Param	object	是	歸檔參數。
ArchiveMethod	string	是	歸檔目標資料庫。說明除歸檔目標為內建儲存，其他歸檔目標涉及的資料庫需要先錄入至 DMS 中，且執行個體在控制台顯示已登入。 inner_oss：專屬儲存（內建儲存）。 oss_userself：使用者 OSS 。 mysql：RDS MySQL。 polardb：PolarDB MySQL。 adb_mysql：AnalyticDB MySQL 3.0。 lindorm：lindorm。	adb_mysql
RunMethod	string	是	歸檔任務的運行方式。 schedule：周期調度。 now：立即執行。	now
Variables	array<object>	否	歸檔變數配置。使用者可定義時間變數作為歸檔的過濾條件。每一個變數有兩個屬性：name 和 pattern。
	object	否	歸檔變數配置。	{name: "time", pattern: "yyyy-MM-dd\|+2d"}
Name	string	否	時間變數名。若用于歸檔過濾條件，需與過濾條件中的變數名稱一致。	t
Pattern	string	否	時間變數格式。用於定義時間變數的值。更多時間變數格式資訊，請參見組態變數。時間變數格式樣本如下： yyyy-MM-dd\|-3d：業務已耗用時間的前 3 天。 yyyy-MM-dd\|-1w：業務已耗用時間的前 1 周。 yyyy-MM-dd\|-4M：業務已耗用時間的前 4 個月。 yyyy-MM-dd\|-2y：業務已耗用時間的前 2 年。 yyyy-MM-dd\|-3h：業務已耗用時間的前 3 小時。 yyyy-MM-dd\|+5m：業務已耗用時間的後 5 分鐘。說明其中前半部分 yyyy-MM-dd\|為固定值，後半部分中-表示業務時間前，+表示業務時間後。	yyyy-MM-dd\|-3d
Logic	boolean	否	是否為邏輯庫。	false
TableIncludes	array<object>	是	待歸檔的表的集合。
	object	是	歸檔表資訊。
TableName	string	是	表名。	table1
TableWhere	string	否	歸檔配置的 WHERE 過濾條件。若過濾條件中使用時間變數，則過濾條件式格式設定為：欄位名<='${變數名}'。其中變數名與 Variables 參數中對應的 name 保持一致。	gmt_modified<'${t}'
TableMapping	array	否	歸檔目標端的表名。使用 API 呼叫時，無需填寫該參數，系統將使用預設值。
	string	否	歸檔表映射。	table1
OrderAfter	array	否	後置行為。
	string	否	後置行為參數。取值及說明： delete：清理原表已歸檔資料。 check：校正歸檔資料（此操作會存在耗時）。 clear：刪除暫存資料表（該參數在同時配置以上兩項參數時才生效）。	delete
SourceCatalogName	string	是	源庫目錄（catalog）。 def：對於兩層邏輯結構的資料庫，如 MySQL，PolarDB MySQL，AnalyticDB MySQL，固定為 def。 Null 字元串：對於 lindorm 與 MongoDB，填入Null 字元串。 catalog 名：對於三層邏輯結構的資料庫，如 PostgreSQL，填入 catalog 名。	def
SourceSchemaName	string	是	源庫 Schema，源庫與目標庫同名。如 MySQL 為庫名，PostgreSQL 為 Schema 名。	schema_test
SourceInstanceName	string	是	源執行個體名稱。如果為自建/他雲資料庫，您可調用 GetInstance 介面擷取 InstanceId 參數值。	rm-bp187l****380w
TargetInstanceHost	string	是	目標庫 Host，若目標執行個體同時開放了內網與公網，優先寫入內網 Host。若歸檔目標為 OSS，則為 Bucket 名。若歸檔目標為專屬儲存，則為 inner_oss。	amv-bp1****00444.ads.aliyuncs.com
CronStr	string	否	填寫 Crontab 運算式，以便定期執行任務，更多資訊，請參見 Crontab 運算式。當運行方式為周期歸檔時需要填寫該參數。	00 05 11 * * ?
DatabaseId	string	否	資料庫 ID。如果是自建/他雲資料庫，可調用 GetDatabase 介面擷取。如果是阿里雲執行個體，可忽略此參數。	1***

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求的 ID。用於定位日誌，排查問題。	283C461F-11D8-48AA-B695-DF092DA32AF3
Success	boolean	請求是否成功。傳回值如下： true：請求成功。 false：請求失敗。	true
ErrorMessage	string	調用失敗時，返回的錯誤資訊。	UnknownError
ErrorCode	string	調用失敗時，返回的錯誤碼。	UnknownError
CreateOrderResult	array	建立的資料歸檔工單 ID。
	integer	資料歸檔工單 ID。	12*****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "CreateOrderResult": [
    0
  ]
}

錯誤碼

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

變更歷史

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