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 参数

名称	在	必需	类型	说明
api-version	query	True	string	请求的 API 版本。

请求头

名称	必需	类型	说明
max-items-per-page		integer	每个请求要检索的最大项数。 服务器可以选择返回小于请求的编号。
traceparent		string	标识分布式跟踪系统中的请求。
tracestate		string	提供特定于供应商的跟踪标识信息，并且是跟踪父级的配套信息。

响应

名称	类型	说明
200 OK	ImportJobCollection	成功
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"
}

定义

名称	说明
Error	错误定义。
ErrorResponse	错误响应。
ImportJob	包含对要执行的操作、结果和执行元数据的引用的作业。
ImportJobCollection	导入作业对象的集合。
InnerError	比包含错误提供的更具体的错误说明。
status	作业的状态。

Error

错误定义。

名称	类型	说明
code	string	服务特定的错误代码，用作 HTTP 错误代码的子状态。
details	Error[]	内部错误详细信息。
innererror	InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的用户可读表示形式。

ErrorResponse

错误响应。

名称	类型	说明
error	Error	错误详细信息。

ImportJob

包含对要执行的操作、结果和执行元数据的引用的作业。

名称	类型	说明
createdDateTime	string	作业的开始时间。 时间戳采用 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ。
error	Error	执行导入作业时发生的错误 () 的详细信息。
finishedDateTime	string	作业的结束时间。 时间戳采用 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ。
id	string	导入作业的标识符。
inputBlobUri	string	包含文件 (的输入 Azure 存储 blob 的路径，) 描述要在作业中执行的操作。
lastActionDateTime	string	上次服务从作业执行任何操作的时间。 时间戳采用 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ。
outputBlobUri	string	输出 Azure 存储 blob 的路径，其中包含导入作业的错误和进度日志。
purgeDateTime	string	服务从系统中清除作业的时间。 时间戳采用 RFC3339 格式： yyyy-MM-ddTHH:mm:ssZ。
status	status	作业的状态。

ImportJobCollection

导入作业对象的集合。

名称	类型	说明
nextLink	string	用于检索下一页结果的 URI。
value	ImportJob[]	导入作业对象的列表。

InnerError

比包含错误提供的更具体的错误说明。

名称	类型	说明
code	string	比包含的错误提供的错误代码更具体的代码。
innererror	InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。

status

作业的状态。

名称	类型	说明
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string