Jobs - ImportJobs List

Service:

Azure Digital Twins

API Version:

2023-10-31

擷取所有匯入作業。 狀態碼：

• 200 確定

GET https://digitaltwins-hostname/jobs/imports?api-version=2023-10-31

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
max-items-per-page		integer	每個要求擷取的專案數目上限。 伺服器可以選擇傳回小於要求的數位。
traceparent		string	識別分散式追蹤系統中的要求。
tracestate		string	提供廠商特定的追蹤識別資訊，而且是追蹤親和項的隨附專案。

回應

名稱	類型	Description
200 OK	ImportJobCollection	Success
Other Status Codes	ErrorResponse	預設回應。 Headers x-ms-error-code: string

安全性

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

範例

Get all import jobs

Sample Request

HTTP

GET https://digitaltwins-hostname/jobs/imports?api-version=2023-10-31

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "importjob1",
      "inputBlobUri": "path to input blob",
      "outputBlobUri": "path to output blob",
      "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
      "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
      "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
      "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
      "status": "succeeded"
    },
    {
      "id": "importjob2",
      "inputBlobUri": "path to input blob",
      "outputBlobUri": "path to output blob",
      "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
      "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
      "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
      "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
      "status": "succeeded"
    }
  ],
  "nextLink": "url-to-next-page"
}

定義

名稱	Description
Error	錯誤定義。
ErrorResponse	錯誤回應。
ImportJob	作業，其中包含要執行之作業的參考、結果和執行中繼資料。
ImportJobCollection	匯入工作物件的集合。
InnerError	比包含的錯誤所提供更明確的錯誤描述。
status	作業的狀態。

Error

錯誤定義。

名稱	類型	Description
code	string	服務特定的錯誤碼，可作為 HTTP 錯誤碼的子狀態。
details	Error[]	內部錯誤詳細資料。
innererror	InnerError	物件，包含比目前物件有關錯誤更具體的資訊。
message	string	人類可讀取的錯誤標記法。

ErrorResponse

錯誤回應。

名稱	類型	Description
error	Error	錯誤詳細資料。

ImportJob

作業，其中包含要執行之作業的參考、結果和執行中繼資料。

名稱	類型	Description
createdDateTime	string	作業的開始時間。 時間戳記是 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ 。
error	Error	執行匯入作業 () 錯誤的詳細資料。
finishedDateTime	string	作業的結束時間。 時間戳記是 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ 。
id	string	匯入作業的識別碼。
inputBlobUri	string	輸入 Azure 儲存體 Blob 的路徑，其中包含檔案 (s) 描述作業中執行的作業。
lastActionDateTime	string	上次服務會從作業執行任何動作。 時間戳記是 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ 。
outputBlobUri	string	輸出 Azure 儲存體 Blob 的路徑，其中包含匯入作業的錯誤和進度記錄。
purgeDateTime	string	服務會從系統清除作業的時間。 時間戳記是 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ 。
status	status	作業的狀態。

ImportJobCollection

匯入工作物件的集合。

名稱	類型	Description
nextLink	string	要擷取下一頁結果的 URI。
value	ImportJob[]	匯入工作物件的清單。

InnerError

比包含的錯誤所提供更明確的錯誤描述。

名稱	類型	Description
code	string	比包含的錯誤所提供更明確的錯誤碼。
innererror	InnerError	物件，包含比目前物件有關錯誤更具體的資訊。

status

作業的狀態。

名稱	類型	Description
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string