GetDataArchiveOrderDetail - DMS API - Data Management - Alibaba Cloud Documentation Center

Retrieves data archiving ticket details, including creation time, task scheduling, archiving logs, and archived database information.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetDataArchiveOrderDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ID of the data archiving ticket.	868****
Tid	integer	No	The tenant ID. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the DMS console. Manage DMS tenants.	5***

Response elements

Element	Type	Description	Example
	object
TraceId	string	The trace ID for the request.	0a06e1e316757357507896067d3780
Success	boolean	Whether the request was successful. Valid values: true false	true
ErrorMessage	string	The error message returned if the request failed.	User [199295823****] not exist
ErrorCode	string	The error code returned if the request failed.	NoPermission
RequestId	string	The request ID, used for log queries and troubleshooting.	4161CE36-28DF-5191-8A6F-A17076A0B124
DataArchiveOrderDetail	object	The details of the data archiving ticket.
Comment	string	The description of the data archiving ticket.	Archiving of test results
Committer	string	The user who submitted the ticket.	dmstest
CommitterId	integer	The user ID of the ticket submitter. This is a DMS user ID, not an Alibaba Cloud account ID.	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	integer	The ID of the data archiving ticket.	868****
PluginExtraData	object	Additional information about the ticket.
DagInfo	object	The workflow information.
CreatorId	string	The ID of the user who created the task flow.	59****
CronBeginDate	string	The scheduling start time. The task flow is not scheduled before this time.	1970-01-01
CronEndDate	string	The scheduling end time. The task flow is not scheduled after this time.	9999-01-01
CronTrigger	boolean	Whether the archiving task is scheduled. Valid values: true false	false
DWDevelop	boolean	Whether the task is used for data warehouse development. Note This field is reserved and 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	integer	The ID of the deployment record.	93***
Description	string	The description of the workflow.	order id:9099197
EditDagId	integer	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	integer	The ID of the task flow.	24***
IsPublic	integer	Whether the workflow is public. Valid values: 0: not public. 1: public.	0
Legacy	boolean	Whether the task is a historical task. Valid values: true false	false
System	boolean	Whether the task was created by the system. Valid values: true false	false
TenantId	string	The tenant ID.	5***
TriggerOnce	boolean	Whether the workflow runs only once. Valid values: true false	false
DbBaseInfo	object	The database information for the data archiving ticket.
Alias	string	The alias of the database instance.	tf-testAccDMSEnterpriseLogicDatabase853****
AlterTimeout	integer	The query timeout period for the database.	600
AssetControl	boolean	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	Whether the instance is added to the DMS whitelist.	whitelist_done
DbId	integer	The database ID. You can call the SearchDatabase operation to query the database ID. Note You can call the ListDatabases operation to query a physical database ID, or the ListLogicDatabases operation to query a logical database ID.	348****
DbType	string	The database engine type. For valid values, see DbType parameter.	MySQL
DbaId	integer	The DBA ID of the instance.	16****
DbaName	string	The DBA nickname 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 environment type of the database. 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	Whether the instance is flagged for attention. Valid values: true false	false
Host	string	The database connection endpoint.	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	integer	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	Whether the database is a logical database. Valid values: true false	false
OwnerIds	array	The owner IDs of the database, stored as an array. You can call the GetUser or ListUsers operation to query owner IDs. Note The value of OwnerIds is the same as the value of UserId.
	integer	The ID of the owner of the instance.	77****
OwnerNames	array	The usernames of the database owners.
	string	The username of the database owner.	user1
Port	integer	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 instance engine type. For valid values, see DbType parameter.	MySQL
Description	string	The description of the security rule set.	adb_mysql default
FreeOrStable	boolean	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 control mode type 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	integer	The ID of the security rule.	24***
LastMenderId	integer	The user ID of the user who last modified the 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	integer	The number of tables.	201
TnsName	string	The name of TNS.	TNS_4010
UnitType	string	The unit type.	-1
InstanceTotal	integer	The total number of archiving tasks.	2
Instances	array<object>	The list of archiving tasks.
	object
BusinessTime	string	The business time of the task flow, in yyyy-MM-DD HH:mm:ss format.	2023-05-14 16:00:57
DagId	integer	The task flow ID. You can call the ListTaskFlow or ListLhTaskFlowAndScenario operation to query this value.	37***
EndTime	string	The time when the task flow ended, in 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	integer	The ID of the historical task flow.	32***
Id	integer	The instance ID of the running task flow.	24***
LastRunningContext	string	The execution context of the previous run.	{ "nodes": [ 48** ], "edges": {} }
Msg	string	The execution context of the current run.	Archiving task log: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	The task status. 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	integer	The trigger mode of the task flow. 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 next scheduled trigger time.
CronFireType	string	The scheduled trigger type.	NOT_SET
PageIndex	integer	The page number.	10
PageSize	integer	The number of entries per page.	20
TempTableNameMap	object	The temporary table name generated by the archiving task, keyed by archiving task ID.	{ "803***": [ "tmp_dms_21321_20230704144336_temp_test_check" ] }
PluginParam	object	The ticket creation parameter, in JSON format. 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	Whether the database is a logical database. true false	true
OrderAfter	array	The post-archiving action.
	string	The post-archiving action. The action uses the DELETE statement to clean up the table.	delete
RunMethod	string	The execution method: run immediately or at a scheduled time.	now
SourceDatabaseId	integer	The ID of the source database.	12***
TableIncludes	array<object>	The archived tables and their filter conditions.
	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 schema mapping.
	string	The mapping of source and destination table names and column names.	{ "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 for scheduled archiving.
	string	The time variable that calculates an offset based on the previous day.	{ "name": "test", "pattern": "yyyy-MM-dd\|-10d" }
PluginType	string	The plug-in type for the ticket. The plug-in type for data archiving is DATA_ARCHIVE. PluginType parameter.	DATA_ARCHIVE
RelatedUserList	array	The user IDs related to the ticket.
	integer	The user IDs related to the ticket.	65****
RelatedUserNickList	array	The nicknames of the users that are related to the ticket.
	string	The nickname of the user that is related to the ticket.	publicyuhzou
StatusCode	string	The ticket status code. 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.	Executing ticket task.
WorkflowInstanceId	integer	The approval process ID. You can call the GetOrderBaseInfo operation to query this value.	29****
WorkflowStatusDesc	string	The description of the approval process.	Approved

Examples

Success response

JSON format

{
  "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": "Medium",
        "Logic": false,
        "OwnerIds": [
          0
        ],
        "OwnerNames": [
          "user1"
        ],
        "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": "Archiving task log: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": "Executing ticket task.",
    "WorkflowInstanceId": 0,
    "WorkflowStatusDesc": "Approved"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.