Jobs - ImportJobs Cancel

Service:

Azure Digital Twins

API Version:

2023-10-31

取消当前正在运行的导入作业。 服务将停止正在进行的当前导入作业触发的任何导入操作，并进入取消状态。 请注意，这将使实例处于未知状态，因为不会执行任何回滚操作。 状态代码：

• 200 个已接受请求
• 400 错误的请求
  • ValidationFailed - 导入作业请求无效。

POST https://digitaltwins-hostname/jobs/imports/{id}/cancel?api-version=2023-10-31

URI 参数

名称	在	必需	类型	说明
id	path	True	string	导入作业的 ID。 ID 在服务中是唯一的，区分大小写。
api-version	query	True	string	请求的 API 版本。

请求头

名称	必需	类型	说明
traceparent		string	标识分布式跟踪系统中的请求。
tracestate		string	提供特定于供应商的跟踪标识信息，并且是跟踪父级的配套信息。

响应

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

示例

Cancel a job

Sample Request

HTTP

POST https://digitaltwins-hostname/jobs/imports/importjob1/cancel?api-version=2023-10-31

Sample Response

Status code:

200

{
  "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",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "cancelling"
}

定义

名称	说明
Error	错误定义。
ErrorResponse	错误响应。
ImportJob	包含对要执行的操作、结果和执行元数据的引用的作业。
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	作业的状态。

InnerError

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

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

status

作业的状态。

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