调用CreateDataArchiveOrder创建数据归档工单_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

使用此API可以创建数据归档工单，将数据归档至专属存储、RDS MySQL等目标中。

接口说明

仅安全协同的数据库实例可调用此 API。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dms:CreateDataArchiveOrder	create	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Comment	string	是	任务描述信息。	业务测试
Tid	long	否	租户 ID，可通过调用接口 GetUserActiveTenant 或 ListUserTenants 获取该参数的值。	3***
PluginType	string	否	插件类型信息，默认为 DATA_ARCHIVE。	DATA_ARCHIVE
RelatedUserList	array	否	相关用户列表。
	string	否	工单相关人 ID。	123***
ParentId	long	否	父工单 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	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。空字符串：对于 lindorm 与 MongoDB，填入空字符串。 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。
OrderIds	long	数据归档工单 ID。	12*****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-13	API 内部配置变更，不影响调用	查看变更详情