GetDataArchiveOrderDetail - Data Management

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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

Parameter	Type	Description	Example
	object
TraceId	string	Tracks service requests.	0a06e1e316757357507896067d3780
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ErrorMessage	string	The error message that is returned if the request failed.	User [19929582****] not exist
ErrorCode	string	The error code returned if the call failed.	NoPermission
RequestId	string	The ID of the request, which is used to query logs and troubleshoot issues.	4161CE36-28DF-5191-8A6F-A17076A0B124
DataArchiveOrderDetail	object	The details of data archiving tickets.
Comment	string	The description of the data archiving tickets.	Archiving of test results
Committer	string	The user who submitted the ticket.	dmstest
CommitterId	long	The ID of the user who submitted the ticket. The ID is a user ID and not the ID of an Alibaba Cloud account.	26***
GmtCreate	string	The time when the ticket was created.	2023-05-15 16:00:48
GmtModified	string	The time when the ticket was last modified.	2023-05-23 16:00:48
Id	long	The ID of data archiving tickets.	868****
PluginExtraData	object	The additional information about the ticket.
DagInfo	object	The information about the workflow.
CreatorId	string	The ID of the user who created the task flow.	59****
CronBeginDate	string	The start time for scheduling. The task flow is not scheduled before this point in time.	1970-01-01
CronEndDate	string	The end time for scheduling. The task flow is not scheduled after this point in time.	9999-01-01
CronTrigger	boolean	Indicates whether the archiving task is a scheduled task. Valid values: true false	false
DWDevelop	boolean	Indicates whether the task is used to develop warehouses. Note This field is a retained field that is not in use.	false
DagName	string	The name of the workflow.	data-archive-9099197
DagOwnerId	string	The ID of the owner of the workflow.	13****
DeployId	long	The ID of the deployment record.	93***
Description	string	The description of the workflow.	order id:9099197
EditDagId	long	The ID of the editable workflow version.	24***
GmtCreate	string	The time when the workflow was created.	2023-05-15 16:00:48
GmtModified	string	The time when the workflow was last modified.	2023-06-15 16:00:48
Id	long	The ID of the task flow.	24***
IsPublic	long	Indicates whether the workflow is public. Valid values: 0: not public. 1: public.	0
Legacy	boolean	Indicates whether the task is a historical task. Valid values: true false	false
System	boolean	Indicates whether the task was created by the system. Valid values: true false	false
TenantId	string	The tenant ID.	5***
TriggerOnce	boolean	Indicates whether the workflow is triggered to run once. Valid values: true false	false
DbBaseInfo	object	The database information related to data archiving tickets.
Alias	string	The alias of the database instance.	tf-testAccDMSEnterpriseLogicDatabase853****
AlterTimeout	long	The timeout period of queries on the database.	600
AssetControl	boolean	Indicates whether access control is enabled for data assets. Valid values: true false	true
CatalogName	string	The name of the instance in the instance list.	test
ClusterNode	string	Indicates whether the instance is added to the DMS whitelist.	whitelist_done
DbId	long	The ID of the database. You can call the SearchDatabase operation to query the ID of the database. Note You can call the ListDatabases operation to query the ID of a physical database or the ListLogicDatabases operation to query the ID of a logical database.	348****
DbType	string	The type of the database. For information about the valid values of this parameter, see DbType parameter.	MySQL
DbaId	long	The ID of the database administrator (DBA) of the instance.	16****
DbaName	string	The nickname of the DBA of the instance.	DBA
Description	string	The complete endpoint of the database.	test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]
Encoding	string	The encoding format of the database.	utf8
EnvType	string	The type of the environment to which the database belongs. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: system integration testing (SIT) environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment	product
Follow	boolean	Indicates whether the instance needs special attention. Valid values: true false	false
Host	string	The endpoint that is used to connect to the database.	rm-2ze756u8837****.mysql.rds.aliyuncs.com
Idc	string	The region in which the database instance resides.	cn-beijing
IdcTitle	string	The name of the region in which the database instance resides.	cn-beijing
InstanceId	long	The ID of the instance to which the database belongs.	175****
InstanceSource	string	The source of the database instance.Valid values: RDS: an ApsaraDB RDS instance. ECS_OWN: a self-managed database deployed on an Elastic Compute Service (ECS) instance. PUBLIC_OWN: a self-managed database instance that is connected over the Internet. VPC_ID: a self-managed database instance in a virtual private cloud (VPC) that is connected over Express Connect circuits. GATEWAY: a database instance connected by using a database gateway.	RDS
LastSyncTime	string	The time when the database information was last obtained.	2023-05-14 18:34:45
Level	string	The instance level.	medium
Logic	boolean	Indicates whether the database is logical. Valid values: true false	false
OwnerIds	array	The IDs of the owners of the databases, which are stored as an array. You can call the GetUser or ListUsers operation to query the IDs of the owners. Note The value of OwnerIds is the same as the value of UserId
OwnerIds	long	The ID of the owner of the instance.	77****
OwnerNames	array	The usernames of the database owners.
OwnerNames	string	The username of the database owner.	day
Port	long	The port that is used to connect to the database.	3306
SchemaName	string	The name of the database.	test
SearchName	string	The name that is used to search for the database.	test@rm-2ze756u8837****.mysql.rds.aliyuncs.com:3306 [test]
StandardGroup	object	The details of the control mode of the instance.
DbType	string	The type of the instance engine. For information about the valid values of this parameter, see DbType parameter.	MySQL
Description	string	The description of the security rule set.	adb_mysql default
FreeOrStable	boolean	Indicates whether the instance is managed in Flexible Management or Stable Change mode. Valid values: true false	false
GmtCreate	string	The time when the security rule was created.	2020-05-24 14:12:32
GmtModified	string	The time when the security rule was last modified.	2020-05-25 14:12:32
GroupMode	string	The type of the control mode of the instance. Valid values: COMMON: The instance is managed in Security Collaboration mode. NONE_CONTROL: The instance is managed in Flexible Management mode. STABLE: The instance is managed in Stable Change mode.	COMMON
GroupName	string	The name of the security rule that corresponds to the control mode.	adb_mysql default
Id	long	The ID of the security rule.	24***
LastMenderId	long	The user ID of the last modified security rule.	12****
State	string	The status of the database. Valid values: NORMAL: The database is running as expected. DISABLE: The database is disabled. OFFLINE: The database is unpublished. NOT_EXIST: The database does not exist.	NORMAL
TableCount	long	The number of tables.	201
TnsName	string	The name of TNS.	TNS_4010
UnitType	string	The unit type.	-1
InstanceTotal	long	The total number of archiving tasks.	2
Instances	array<object>	The list of archiving tasks.
Instances	object
BusinessTime	string	The business time of the task flow. The time is displayed in the yyyy-MM-DD HH:mm:ss format.	2023-05-14 16:00:57
DagId	long	The task flow ID. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to obtain the value of this parameter.	37***
EndTime	string	The time when the task flow ended. The time is displayed in the yyyy-MM-DD HH:mm:ss format.	2022-06-04 15:14:00
GmtCreate	string	The time when the task flow was created.	2023-05-14 16:00:57
GmtModified	string	The time when the task flow was last modified.	2023-05-14 16:00:57
HistoryDagId	long	The ID of the historical task flow.	32***
Id	long	The ID of the instance in the task flow that is executed.	24***
LastRunningContext	string	The context of the previous execution of the task flow.	{ "nodes": [ 48** ], "edges": {} }
Msg	string	The context of the current execution of the task flow.	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	long	The status of the task. Valid values: 0: The task is waiting for execution. 1: The task is in progress. 2: The task is suspended. 3: The task failed. 4: The task is successful. 5: The task is complete.	4
TenantId	string	The tenant ID.	5***
TriggerType	long	The mode in which the task flow was triggered. Valid values: 0: The task flow was triggered based on a schedule. 1: The task flow was manually triggered.	1
Version	string	The version number.	1
NextFireTimeResult	object	The time when the next task is triggered.
CronFireType	string	The type of scheduled triggering.	NOT_SET
PageIndex	long	The page number.	10
PageSize	long	The number of entries per page.	20
TempTableNameMap	object	The name of the temporary table that is generated by the archiving task (indicated by the archiving task ID).	{ "803***": [ "tmp_dms_21321_20230704144336_temp_test_check" ] }
PluginParam	object	The ticket creation parameter. The value is a JSON string. For more information, see PluginType parameter.
ArchiveMethod	string	The type of the archiving destination.	inner_oss
DbSchema	string	The schema of the database and table to be archived.	test
Logic	boolean	Indicates whether the database is logical. true false	true
OrderAfter	array	The post behavior of archiving.
AfterOrder	string	The post behavior of archiving. The post behavior is to use the DELETE statement to clean up the table.	delete
RunMethod	string	The running method, which indicates whether to run the task immediately or at a specific point in time.	now
SourceDatabaseId	long	The ID of the source database.	12***
TableIncludes	array<object>	The list of the archived tables and the filter conditions.
IncludeTables	object
TableName	string	The table name.	tm_insured_cb
TableWhere	string	The filter condition.	id<1000 or gmt_create<'2023-05-14 16:00:57'
TableMapping	array	The mapping of schemas.
MappingTable	string	The mapping of the source table name, source column name, destination table name, and destination column name.	{ "schema": "oracle_info", "tarTb": "eoa_context_test", "tbPartKey": [], "oriTb": "eoa_context", "columns": [ { "tName": "dbid_test", "oName": "dbid" } ], "dbPartKey": [], "customPk": [ "id" ] }
TargetInstanceId	string	The ID of the destination instance.	12***
Variables	array	The time variable defined for scheduled archiving.
Variables	string	The time variable that calculates an offset based on the previous day of the current time.	{ "name": "test", "pattern": "yyyy-MM-dd\|-10d" }
PluginType	string	The plug-in type that corresponds to the type of the ticket. The plug-in type for data archiving is DATA_ARCHIVE. For more information, see PluginType parameter.	DATA_ARCHIVE
RelatedUserList	array	The user IDs related to the ticket.
RelatedUserList	long	The user IDs related to the ticket.	65****
RelatedUserNickList	array	The nicknames of the users that are related to the ticket.
RelatedUserNickList	string	The nickname of the user that is related to the ticket.	publicyuhzou
StatusCode	string	The status code of the ticket. Valid values: new: newly created. toaudit: being reviewed. Approved: approved. reject: rejected. processing: being executed. Success: successful. closed: disabled.	processing
StatusDesc	string	The status description of the ticket.	a ticket task is being executed.
WorkflowInstanceId	long	The ID of the approval process. You can call the GetOrderBaseInfo operation to obtain the ID of the approval process.	29****
WorkflowStatusDesc	string	The description of the approval process.	approved

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