调用此API获取数据归档工单详情，包含工单的创建时间、任务调度信息、归档任务日志和归档数据库的信息等。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:GetDataArchiveOrderDetail | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| OrderId | long | 是 | 数据归档工单号。 | 868**** |
| Tid | long | 否 | 租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息，详情请参见查看租户信息。
| 5*** |
返回参数
示例
正常返回示例
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": "审批通过"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-07-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |