GetDataArchiveOrderDetail - 获取数据归档工单详情 - 数据管理 DMS

调用此API获取数据归档工单详情，包含工单的创建时间、任务调度信息、归档任务日志和归档数据库的信息等。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:GetDataArchiveOrderDetail

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
OrderId	integer	是	数据归档工单号。	868****
Tid	integer	否	租户 ID。说明取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。	5***

返回参数

名称	类型	描述	示例值
	object
TraceId	string	用于跟踪服务请求。	0a06e1e316757357507896067d3780
Success	boolean	查询是否成功： true：成功。 false：失败。	true
ErrorMessage	string	错误信息。	User [199295823****] not exist
ErrorCode	string	错误码。	NoPermission
RequestId	string	请求的 ID。用于定位日志，排查问题。	4161CE36-28DF-5191-8A6F-A17076A0B124
DataArchiveOrderDetail	object	数据归档工单详情。
Comment	string	数据归档工单的备注信息。	Archiving of test results
Committer	string	工单提交者。	dmstest
CommitterId	integer	工单提交者的用户 ID，非阿里云 UID。	26***
GmtCreate	string	工单的创建时间。	2023-05-15 16:00:48
GmtModified	string	最后一次修改工单的时间。	2023-05-23 16:00:48
Id	integer	数据归档工单 ID。	868****
PluginExtraData	object	工单的额外信息。
DagInfo	object	工作流信息。
CreatorId	string	创建人的用户 ID。	59****
CronBeginDate	string	定时任务开始调度的时间。此时间点之前任务流不进行调度。	1970-01-01
CronEndDate	string	定时任务结束调度的时间。此时间点之后任务流不再进行调度。	9999-01-01
CronTrigger	boolean	归档任务是否是周期任务。返回值： true false	false
DWDevelop	boolean	是否用于数仓开发。说明该字段为暂不使用的保留字段。	false
DagName	string	工作流名称。	data-archive-9099197
DagOwnerId	string	工作流 Owner 的用户 ID。	13****
DeployId	integer	部署记录 ID。	93***
Description	string	工作流的描述信息。	order id:9099197
EditDagId	integer	可编辑工作流版本的 ID。	24***
GmtCreate	string	创建工作流的时间。	2023-05-15 16:00:48
GmtModified	string	最后修改工作流的时间。	2023-06-15 16:00:48
Id	integer	任务流 ID。	24***
IsPublic	integer	是否公开该工作流。返回值： 0：不公开。 1：公开。	0
Legacy	boolean	是否为历史任务。返回值： true false	false
System	boolean	是否为系统创建。返回值： true false	false
TenantId	string	租户 ID。	5***
TriggerOnce	boolean	该工作流是否触发运行一次。返回值： true false	false
DbBaseInfo	object	数据归档工单相关的数据库信息。
Alias	string	实例别名。	tf-testAccDMSEnterpriseLogicDatabase853****
AlterTimeout	integer	数据库设置的查询超时时间。	600
AssetControl	boolean	是否开启数据资产访问控制。返回值： true false	true
CatalogName	string	实例在实例列表中的名称。	test
ClusterNode	string	实例增加 DMS 白名单的情况。	whitelist_done
DbId	integer	数据库 ID（DatabaseId），可调用 SearchDatabase 接口获取该参数的值。说明您也可以调用 ListDatabases 接口获取物理库的 DatabaseId 值，调用 ListLogicDatabases 接口获取逻辑库的 DatabaseId 值。	348****
DbType	string	数据库类型，取值请参见 DbType 参数说明。	MySQL
DbaId	integer	实例 DBA 的用户 ID。	16****
DbaName	string	实例 DBA 的昵称。	DBA
Description	string	完整的数据库地址。	test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]
Encoding	string	数据库编码。	utf8
EnvType	string	数据库环境类型，返回值： product：生产环境。 dev：开发环境。 pre：预发环境。 test：测试环境。 sit：SIT 环境。 uat：UAT 环境。 pet：压测环境。 stag：STAG 环境。	product
Follow	boolean	是否为关注的实例。返回值： true false	false
Host	string	数据库连接地址。	rm-2ze756u8837****.mysql.rds.aliyuncs.com
Idc	string	数据库所在地域。	cn-beijing
IdcTitle	string	数据库所在地域的名称。	cn-beijing
InstanceId	integer	数据库所属的实例 ID。	175****
InstanceSource	string	实例来源，返回值如下： RDS：阿里云数据库实例。 ECS_OWN：阿里云 ECS 自建库实例。 PUBLIC_OWN：公网自建库实例。 VPC_ID：VPC 专线 IDC 数据库实例。 GATEWAY：数据库网关实例。	RDS
LastSyncTime	string	上一次获取数据库信息的时间。	2023-05-14 18:34:45
Level	string	实例级别。	中
Logic	boolean	数据库是否为逻辑库。返回值： true false	false
OwnerIds	array	数据库 Owner 的用户 ID，多个用户 ID 将以数组形式保存。可调用 GetUser 或 ListUsers 接口获取 UserId 的值。说明用户 ID 的参数名为 UserId。
	integer	Owner ID。	77****
OwnerNames	array	数据库 Owner 的用户名列表。
	string	Owner 的用户名。	天天
Port	integer	数据库的连接端口。	3306
SchemaName	string	数据库名。	test
SearchName	string	数据库搜索名。	test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]
StandardGroup	object	实例的管控模式详情。
DbType	string	实例的引擎类型，取值请参见 DbType 参数说明。	MySQL
Description	string	安全规则集描述。	adb_mysql default
FreeOrStable	boolean	实例的管控模式是否为自由操作或稳定变更。返回值： true false	false
GmtCreate	string	添加安全规则的时间。	2020-05-24 14:12:32
GmtModified	string	修改安全规则的时间。	2020-05-25 14:12:32
GroupMode	string	实例关联的管控模式类型。返回值： COMMON：安全协同。 NONE_CONTROL：自由操作。 STABLE：稳定变更。	COMMON
GroupName	string	管控模式对应的安全规则名称。	adb_mysql default
Id	integer	安全规则 ID。	24***
LastMenderId	integer	最近修改安全规则的用户 ID。	12****
State	string	实例状态。返回值： NORMAL：正常。 DISABLE：禁用。 OFFLINE：下线。 NOT_EXIST：不存在。	NORMAL
TableCount	integer	表数量。	201
TnsName	string	tns 名称。	TNS_4010
UnitType	string	单元化类型。	-1
InstanceTotal	integer	归档任务的总数量。	2
Instances	array<object>	归档任务列表。
	object	任务的详情信息。
BusinessTime	string	任务流的业务时间，时间格式为 yyyy-MM-DD HH:mm:ss。	2023-05-14 16:00:57
DagId	integer	整个任务的 ID，可调用 ListTaskFlow 或 ListLhTaskFlowAndScenario 接口获取该参数的值。	37***
EndTime	string	任务流结束运行的时间，时间格式为 yyyy-MM-DD HH:mm:ss。	2022-06-04 15:14:00
GmtCreate	string	创建任务流的时间。	2023-05-14 16:00:57
GmtModified	string	更新任务流的时间。	2023-05-14 16:00:57
HistoryDagId	integer	历史任务流 ID。	32***
Id	integer	在运行任务流中的实例 ID。	24***
LastRunningContext	string	上次任务流运行的情况。	{ "nodes": [ 48** ], "edges": {} }
Msg	string	本次任务运行的详细信息。	归档任务日志：2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023
Status	integer	任务运行状态。返回值如下： 0：等待执行。 1：运行中。 2：暂停。 3：失败。 4：成功。 5：运行结束。	4
TenantId	string	租户 ID。	5***
TriggerType	integer	触发类型。返回值如下： 0：周期调度。 1：手动运行。	1
Version	string	版本号。	1
NextFireTimeResult	object	下次任务触发时间。
CronFireType	string	周期触发类型。	NOT_SET
PageIndex	integer	分页页码。	10
PageSize	integer	每页返回的结果个数。	20
TempTableNameMap	object	归档生成的临时表名（根据归档任务 ID 区分）。	{ "803***": [ "tmp_dms_21321_20230704144336_temp_test_check" ] }
PluginParam	object	创建工单参数，格式为 JSON 形式的字符串。详细信息，请参见 PluginType 参数说明。
ArchiveMethod	string	归档目标类型。	inner_oss
DbSchema	string	归档库表 Schema。	test
Logic	boolean	是否为逻辑库，返回值： true：是。 false：否。	true
OrderAfter	array	归档后置行为。
	string	归档后置行为。该后置行为主要使用 Delete 完成库表清理。	delete
RunMethod	string	运行方法，指立刻运行还是指定时间运行任务。	now
SourceDatabaseId	integer	源数据库的 ID。	12***
TableIncludes	array<object>	归档的表列表和过滤条件。
	object	表名和过滤条件。
TableName	string	表名。	tm_insured_cb
TableWhere	string	过滤条件。	id<1000或者gmt_create<'2023-05-14 16:00:57'
TableMapping	array	库表映射。
	string	源表和目标表的表名、列名映射。	{ "schema": "oracle_info", "tarTb": "eoa_context_test", "tbPartKey": [], "oriTb": "eoa_context", "columns": [ { "tName": "dbid_test", "oName": "dbid" } ], "dbPartKey": [], "customPk": [ "id" ] }
TargetInstanceId	string	目标实例 ID。	12***
Variables	array	定义的时间变量，用于周期归档。
	string	时间变量，根据当前时间的前一天进行偏移计算。	{ "name": "test", "pattern": "yyyy-MM-dd\|-10d" }
PluginType	string	工单类型对应的 PluginType，数据归档的 PluginType 为 DATA_ARCHIVE。更多信息，请参见 PluginType 参数说明。	DATA_ARCHIVE
RelatedUserList	array	工单相关人的用户 ID。
	integer	工单相关人的用户 ID。	65****
RelatedUserNickList	array	工单相关人的昵称列表。
	string	工单相关人的昵称。	publicyuhzou
StatusCode	string	工单状态码，返回值： new：新建。 toaudit：审批中。 approved：审批通过。 reject：审批拒绝。 processing：执行中。 success：执行成功。 closed：已关闭。	processing
StatusDesc	string	工单状态描述。	正在执行工单任务。
WorkflowInstanceId	integer	审批流 ID，可调用 GetOrderBaseInfo 接口获取该参数的值。	29****
WorkflowStatusDesc	string	审批描述信息。	审批通过

示例

正常返回示例

JSON格式

{
  "TraceId": "0a06e1e316757357507896067d3780",
  "Success": true,
  "ErrorMessage": "User [199295823****] not exist",
  "ErrorCode": "NoPermission",
  "RequestId": "4161CE36-28DF-5191-8A6F-A17076A0B124",
  "DataArchiveOrderDetail": {
    "Comment": "Archiving of test results",
    "Committer": "dmstest",
    "CommitterId": 0,
    "GmtCreate": "2023-05-15 16:00:48",
    "GmtModified": "2023-05-23 16:00:48",
    "Id": 0,
    "PluginExtraData": {
      "DagInfo": {
        "CreatorId": "59****",
        "CronBeginDate": "1970-01-01",
        "CronEndDate": "9999-01-01",
        "CronTrigger": false,
        "DWDevelop": false,
        "DagName": "data-archive-9099197",
        "DagOwnerId": "13****",
        "DeployId": 0,
        "Description": "order id:9099197",
        "EditDagId": 0,
        "GmtCreate": "2023-05-15 16:00:48",
        "GmtModified": "2023-06-15 16:00:48",
        "Id": 0,
        "IsPublic": 0,
        "Legacy": false,
        "System": false,
        "TenantId": "5***",
        "TriggerOnce": false
      },
      "DbBaseInfo": {
        "Alias": "tf-testAccDMSEnterpriseLogicDatabase853****",
        "AlterTimeout": 600,
        "AssetControl": true,
        "CatalogName": "test",
        "ClusterNode": "whitelist_done",
        "DbId": 0,
        "DbType": "MySQL",
        "DbaId": 0,
        "DbaName": "DBA",
        "Description": "test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]",
        "Encoding": "utf8",
        "EnvType": "product",
        "Follow": false,
        "Host": "rm-2ze756u8837****.mysql.rds.aliyuncs.com",
        "Idc": "cn-beijing",
        "IdcTitle": "cn-beijing",
        "InstanceId": 0,
        "InstanceSource": "RDS",
        "LastSyncTime": "2023-05-14 18:34:45",
        "Level": "中",
        "Logic": false,
        "OwnerIds": [
          0
        ],
        "OwnerNames": [
          "天天"
        ],
        "Port": 3306,
        "SchemaName": "test",
        "SearchName": "test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]",
        "StandardGroup": {
          "DbType": "MySQL",
          "Description": "adb_mysql default",
          "FreeOrStable": false,
          "GmtCreate": "2020-05-24 14:12:32",
          "GmtModified": "2020-05-25 14:12:32",
          "GroupMode": "COMMON",
          "GroupName": "adb_mysql default",
          "Id": 0,
          "LastMenderId": 0
        },
        "State": "NORMAL",
        "TableCount": 201,
        "TnsName": "TNS_4010",
        "UnitType": "-1"
      },
      "InstanceTotal": 2,
      "Instances": [
        {
          "BusinessTime": "2023-05-14 16:00:57",
          "DagId": 0,
          "EndTime": "2022-06-04 15:14:00",
          "GmtCreate": "2023-05-14 16:00:57",
          "GmtModified": "2023-05-14 16:00:57",
          "HistoryDagId": 0,
          "Id": 0,
          "LastRunningContext": "{\n      \"nodes\": [\n            48**\n      ],\n      \"edges\": {}\n}",
          "Msg": "归档任务日志：2023-05-15 16:37:48[GMT+08:00] INFO - Resource Control is active!\\n2023-05-15 16:37:48[GMT+08:00] INFO - Starting job j_4834 at Mon May 15 16:37:48 CST 2023",
          "Status": 4,
          "TenantId": "5***",
          "TriggerType": 1,
          "Version": "1"
        }
      ],
      "NextFireTimeResult": {
        "CronFireType": "NOT_SET"
      },
      "PageIndex": 10,
      "PageSize": 20,
      "TempTableNameMap": {
        "803***": [
          "tmp_dms_21321_20230704144336_temp_test_check"
        ]
      }
    },
    "PluginParam": {
      "ArchiveMethod": "inner_oss",
      "DbSchema": "test",
      "Logic": true,
      "OrderAfter": [
        "delete"
      ],
      "RunMethod": "now",
      "SourceDatabaseId": 0,
      "TableIncludes": [
        {
          "TableName": "tm_insured_cb",
          "TableWhere": "id<1000或者gmt_create<'2023-05-14 16:00:57'"
        }
      ],
      "TableMapping": [
        "{\n                    \"schema\": \"oracle_info\",\n                    \"tarTb\": \"eoa_context_test\",\n                    \"tbPartKey\": [],\n                    \"oriTb\": \"eoa_context\",\n                    \"columns\": [\n                        {\n                            \"tName\": \"dbid_test\",\n                            \"oName\": \"dbid\"\n                        }\n                    ],\n                    \"dbPartKey\": [],\n                    \"customPk\": [\n                        \"id\"\n                    ]\n                }"
      ],
      "TargetInstanceId": "12***",
      "Variables": [
        "{\n                    \"name\": \"test\",\n                    \"pattern\": \"yyyy-MM-dd|-10d\"\n                }"
      ]
    },
    "PluginType": "DATA_ARCHIVE",
    "RelatedUserList": [
      0
    ],
    "RelatedUserNickList": [
      "publicyuhzou"
    ],
    "StatusCode": "processing",
    "StatusDesc": "正在执行工单任务。",
    "WorkflowInstanceId": 0,
    "WorkflowStatusDesc": "审批通过"
  }
}

错误码

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

变更历史

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