使用此API可以創(chuàng)建數(shù)據(jù)歸檔工單，將數(shù)據(jù)歸檔至專屬存儲、RDS MySQL等目標(biāo)中。
接口說明
僅安全協(xié)同的數(shù)據(jù)庫實例可調(diào)用此 API。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dms:CreateDataArchiveOrder | create | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Comment | string | 是 | 任務(wù)描述信息。 | 業(yè)務(wù)測試 |
| Tid | long | 否 | 租戶 ID，可通過調(diào)用接口 GetUserActiveTenant 或 ListUserTenants 獲取該參數(shù)的值。 | 3*** |
| PluginType | string | 否 | 插件類型信息，默認(rèn)為 DATA_ARCHIVE。 | DATA_ARCHIVE |
| RelatedUserList | array | 否 | 相關(guān)用戶列表。 | |
| string | 否 | 工單相關(guān)人 ID。 | 123*** | |
| ParentId | long | 否 | 父工單 ID。創(chuàng)建子工單時才會有父工單。 | 896**** |
| Param | object | 是 | 歸檔參數(shù)。 | |
| ArchiveMethod | string | 是 | 歸檔目標(biāo)數(shù)據(jù)庫。 說明
除歸檔目標(biāo)為內(nèi)置存儲，其他歸檔目標(biāo)涉及的數(shù)據(jù)庫需要先錄入至 DMS 中，且實例在控制臺顯示已登錄。
| adb_mysql |
| RunMethod | string | 是 | 歸檔任務(wù)的運行方式。
| now |
| Variables | array<object> | 否 | 歸檔變量配置。用戶可定義時間變量作為歸檔的過濾條件。每一個變量有兩個屬性：name 和 pattern。 | |
| object | 否 | 歸檔變量配置。 | ||
| Name | string | 否 | 時間變量名。 若用于歸檔過濾條件，需與過濾條件中的變量名稱一致。 | t |
| Pattern | string | 否 | 時間變量格式。用于定義時間變量的值。更多時間變量格式信息，請參見配置變量。 時間變量格式示例如下：
說明
其中前半部分 yyyy-MM-dd|為固定值，后半部分中-表示業(yè)務(wù)時間前，+表示業(yè)務(wù)時間后。
| yyyy-MM-dd|-3d |
| Logic | boolean | 否 | 是否為邏輯庫。 | false |
| TableIncludes | array<object> | 是 | 待歸檔的表的集合。 | |
| object | 是 | 歸檔表信息。 | ||
| TableName | string | 是 | 表名。 | table1 |
| TableWhere | string | 否 | 歸檔配置的 WHERE 過濾條件。 若過濾條件中使用時間變量，則過濾條件格式為：字段名<='${變量名}'。其中變量名與 Variables 參數(shù)中對應(yīng)的 name 保持一致。 | gmt_modified<'${t}' |
| TableMapping | array | 否 | 歸檔目標(biāo)端的表名。使用 API 調(diào)用時，無需填寫該參數(shù)，系統(tǒng)將使用默認(rèn)值。 | |
| string | 否 | 歸檔表映射。 | table1 | |
| OrderAfter | array | 否 | 后置行為。 | |
| string | 否 | 后置行為參數(shù)。取值及說明：
| delete | |
| SourceCatalogName | string | 是 | 源庫目錄（catalog）。
| def |
| SourceSchemaName | string | 是 | 源庫 Schema，源庫與目標(biāo)庫同名。 如 MySQL 為庫名，PostgreSQL 為 Schema 名。 | schema_test |
| SourceInstanceName | string | 是 | 源實例名稱。 如果為自建/他云數(shù)據(jù)庫，您可調(diào)用 GetInstance 接口獲取 InstanceId 參數(shù)值。 | rm-bp187l****380w |
| TargetInstanceHost | string | 是 | 目標(biāo)庫 Host，若目標(biāo)實例同時開放了內(nèi)網(wǎng)與公網(wǎng)，優(yōu)先寫入內(nèi)網(wǎng) Host。
| amv-bp1****00444.ads.aliyuncs.com |
| CronStr | string | 否 | 填寫 Crontab 表達式，以便定期執(zhí)行任務(wù)，更多信息，請參見 Crontab 表達式。 當(dāng)運行方式為周期歸檔時需要填寫該參數(shù)。 | 00 05 11 * * ? |
| DatabaseId | string | 否 | 數(shù)據(jù)庫 ID。 如果是自建/他云數(shù)據(jù)庫，可調(diào)用 GetDatabase 接口獲取。 如果是阿里云實例，可忽略此參數(shù)。 | 1*** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "283C461F-11D8-48AA-B695-DF092DA32AF3",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"CreateOrderResult": [
0
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-05-13 | API 內(nèi)部配置變更，不影響調(diào)用 | 查看變更詳情 |