調用GetDataArchiveOrderDetail擷取資料歸檔工單詳情-Data Management-阿里雲

調用此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	用於Tracing Service請求。	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	工單提交者的使用者識別碼，非阿里雲 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	建立人的使用者識別碼。	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 的使用者識別碼。	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 的使用者識別碼。	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 的使用者識別碼，多個使用者識別碼將以數組形式儲存。可調用 GetUser 或 ListUsers 介面擷取 UserId 的值。說明使用者識別碼的參數名為 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	最近修改安全規則的使用者識別碼。	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	工單相關人的使用者識別碼。
	integer	工單相關人的使用者識別碼。	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": "審批通過"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。