擷取SQL工作清單。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dms:ListDBTaskSQLJob |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| DBTaskGroupId |
integer |
是 |
SQL 任務分組 ID，您可以調用 GetStructSyncJobDetail 介面擷取該參數。 |
132**** |
| PageNumber |
integer |
否 |
開始頁碼。 |
1 |
| PageSize |
integer |
否 |
每頁資料量。 |
20 |
| Tid |
integer |
否 |
租戶 ID。 說明
取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。 |
1*** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
F6C47680-8D2D-43A4-8902-F2740D71A398 |
| Success |
boolean |
請求是否成功。 |
true |
| ErrorMessage |
string |
錯誤資訊。 |
UnknownError |
| ErrorCode |
string |
錯誤碼。 |
UnknownError |
| DBTaskSQLJobList |
array<object> |
SQL 工作清單。 |
|
|
object |
SQL 任務。 |
||
| JobId |
integer |
SQL 任務 ID。 |
12**** |
| JobType |
string |
SQL 任務類型。 |
STRUCT_SYNC |
| Comment |
string |
SQL 任務備忘資訊。 |
test |
| DbSearchName |
string |
庫搜尋名。 說明
建議您的業務不要強依賴該參數，後續版本的格式可能會發生變化。 |
test@xxx:3306[test] |
| DbId |
integer |
庫 ID。 |
43214523 |
| Logic |
boolean |
是否為邏輯庫，取值：
|
false |
| CreateTime |
string |
建立時間。 |
2021-02-18 17:49:20 |
| LastExecTime |
string |
最後執行時間。 |
2021-02-18 17:49:31 |
| DbTaskGroupId |
integer |
SQL 任務分組 ID。 |
432**** |
| Status |
string |
SQL 詳情狀態，取值：
|
SUCCESS |
| Transactional |
boolean |
是否以事務方式執行，取值：
|
false |
| TotalCount |
integer |
SQL 工作清單總數。 |
1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "F6C47680-8D2D-43A4-8902-F2740D71A398",
"Success": true,
"ErrorMessage": "UnknownError",
"ErrorCode": "UnknownError",
"DBTaskSQLJobList": [
{
"JobId": 0,
"JobType": "STRUCT_SYNC",
"Comment": "test",
"DbSearchName": "test@xxx:3306[test]",
"DbId": 43214523,
"Logic": false,
"CreateTime": "2021-02-18 17:49:20",
"LastExecTime": "2021-02-18 17:49:31",
"DbTaskGroupId": 0,
"Status": "SUCCESS",
"Transactional": false
}
],
"TotalCount": 1
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。