全部產品
Search
文件中心

DataWorks:ListSemanticJobs

更新時間:Sep 03, 2026

分頁查詢目前租戶的語意任務定義。清單項目中的 Name、ProjectId 和 Source 可分別複用於執行/刪除、執行詳情查詢和核對輸入範圍。

介面說明

使用場景

分頁查詢目前租戶已儲存的語意任務定義,用於展示任務清單、選擇任務執行或取得任務所屬工作空間。

呼叫流程

  1. 透過 PageNumber 和 PageSize 分頁讀取 Data.SemanticJobs。

  2. 使用清單項目的 Name 呼叫 RunSemanticJob、DeleteSemanticJob 或 ListSemanticJobRuns。

  3. 使用清單項目的 ProjectId 配合 ExecutorJobId 呼叫詳情、日誌和停止介面。

注意事項

本介面傳回的是任務定義,不是即時執行狀態;執行情況請查詢 ListSemanticJobRuns。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

PageNumber

integer

否

頁碼,從 1 開始;省略或小於等於 0 時按第 1 頁處理。

1

PageSize

integer

否

每頁傳回的任務定義數;省略或小於等於 0 時預設 50,最大 200。

50

請根據各請求欄位的說明建構呼叫參數。

返回參數

名稱

類型

描述

樣本值

object

分頁查詢任務定義的標準回應。Data.SemanticJobs 中每項都是可用於後續執行或查詢的任務定義。

RequestId

string

請求 ID。用於定位日誌和排查問題。

676271D6-53B4-57BE-89FA-72F7AE1418DF

Success

boolean

請求是否成功。

Data

object

任務定義分頁結果。使用清單項目 Name 執行、刪除、查詢執行記錄或下載結果;使用 ProjectId 查詢執行詳情、日誌或停止執行。

TotalCount

integer

目前租戶內符合條件的任務定義總數。

1

PageNumber

integer

本次傳回的頁碼,從 1 開始。

1

PageSize

integer

本次傳回的每頁任務定義數。

50

SemanticJobs

array<object>

任務定義清單。

array<object>

一個已儲存的語意任務定義,其欄位含義與 CreateSemanticJob 的 Data 一致。

Id

integer

任務定義的內部唯一 ID。

1

Name

string

任務名稱;用於 RunSemanticJob、DeleteSemanticJob、ListSemanticJobRuns 和 DownloadSemanticResults。

semantic-job-demo

UserId

string

語義任務建立者的使用者識別碼。

user-demo

Creator

string

語義任務建立者的使用者識別碼。

user-demo

ProjectId

integer

任務所屬工作空間 ID;用於 GetSemanticJobDetail、GetSemanticJobLog 和 KillSemanticJob。

100

Type

string

任務儲存的 Source.type 資料來源類型。

maxcompute

Source

object

任務儲存的輸入資料來源設定;執行時據此選擇分析範圍。

ReferenceFileIds

array

任務關聯的上傳檔案 ID 清單。

string

可選的已上傳參考檔案 ID 清單。

semantic-job-value

ReferenceFileUris

array

任務關聯的外部參考檔案 URI 清單。

string

可選的可存取參考檔案 URI 清單。

semantic-job-value

GmtCreate

integer

建立時間,單位為毫秒的 Unix 時間戳記。

1700000000000

GmtModified

integer

最近修改時間,單位為毫秒的 Unix 時間戳記。

1700000000000

ResourceGroupId

string

執行本任務時使用的資源群組識別碼。

rg-demo

回應欄位含義和後續呼叫關係請參閱各欄位說明。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 50,
    "SemanticJobs": [
      {
        "Id": 1,
        "Name": "semantic-job-demo",
        "UserId": "user-demo",
        "Creator": "user-demo",
        "ProjectId": 100,
        "Type": "maxcompute",
        "Source": {
          "test": "test",
          "test2": 1
        },
        "ReferenceFileIds": [
          "semantic-job-value"
        ],
        "ReferenceFileUris": [
          "semantic-job-value"
        ],
        "GmtCreate": 1700000000000,
        "GmtModified": 1700000000000,
        "ResourceGroupId": "rg-demo"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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