GetStructSyncJobDetail擷取結構同步任務詳情-Data Management-阿里雲

調用GetStructSyncJobDetail擷取結構同步的任務詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetStructSyncJobDetail

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
OrderId	integer	是	工單號。	4324321
Tid	integer	否	租戶 ID。說明取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。	1

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	48602B78-0DDF-414C-8688-70CAB6070115
Success	boolean	請求是否成功。	true
ErrorMessage	string	錯誤資訊。	UnknownError
ErrorCode	string	錯誤碼。	UnknownError
StructSyncJobDetail	object	結構同步任務詳情。
JobStatus	string	任務狀態，取值和說明如下： NEW：新建立。 COMPARING：正在對比結構。 COMPARE_BREAK：對比手動中斷。 COMPARE_FINISH：對比完成。 NOT_SCRIPTS：對比完成, 沒有可執行指令碼。 SUBMITED_DBTASK：已提交 DBTask。 DBTASK_SUCCESS：DBTask 執行成功。 SUBMITED_WORKFLOW：提交審批。 WORKFLOW_SUCCESS：審批結束。	DBTASK_SUCCESS
Message	string	任務描述資訊。	test
TableAnalyzed	integer	已經分析的表。	2
TableCount	integer	表的總數。	2
SqlCount	integer	SQL 總數。	1
ExecuteCount	integer	已執行的 SQL 數量。	1
SecurityRule	string	安全規則描述，取值： CANNOT_SYNC：不允許同步。 WITH_APPROVE：需通過審批後進行同步，可調用 SubmitStructSyncOrderApproval 介面發起審批次程序。 WITHOUT_APPROVE：不需要審批即可進行同步。	WITHOUT_APPROVE
DBTaskGroupId	integer	SQL 任務分組 ID。	12345

樣本

正常返回樣本

JSON格式

{
  "RequestId": "48602B78-0DDF-414C-8688-70CAB6070115",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "StructSyncJobDetail": {
    "JobStatus": "DBTASK_SUCCESS",
    "Message": "test",
    "TableAnalyzed": 2,
    "TableCount": 2,
    "SqlCount": 1,
    "ExecuteCount": 1,
    "SecurityRule": "WITHOUT_APPROVE",
    "DBTaskGroupId": 12345
  }
}

錯誤碼

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

變更歷史

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