Queries the details of a data archiving ticket, including the time when the ticket was created, the scheduling information of the data archiving task, the logs of the data archiving task, and the database to which data is archived.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| OrderId | long | Yes | The IDs of data archiving tickets. | 868**** |
| Tid | long | No | The tenant ID. Note
To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.
| 5*** |
Response parameters
Examples
Sample success responses
JSONformat
{
"TraceId": "0a06e1e316757357507896067d3780",
"Success": true,
"ErrorMessage": "User [19929582****] 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": "medium",
"Logic": false,
"OwnerIds": [
0
],
"OwnerNames": [
"day"
],
"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 or 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": "a ticket task is being executed.",
"WorkflowInstanceId": 0,
"WorkflowStatusDesc": "approved"
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-06 | The response structure of the API has changed | View Change Details |