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	Идентификатор задания импорта. Идентификатор уникален в пределах службы и учитывает регистр.
api-version	query	True	string	Запрошенная версия API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
traceparent		string	Определяет запрос в распределенной системе трассировки.
tracestate		string	Предоставляет сведения об идентификации трассировки для конкретного поставщика и является компаньоном для traceparent.

Ответы

Имя	Тип	Описание
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	Путь к входным BLOB-объектам службы хранилища Azure, который содержит файлы, описывающие операции, выполняемые в задании.
lastActionDateTime	string	Служба в последний раз выполняла какое-либо действие из задания. Метка времени имеет RFC3339 формате: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	Путь к выходному blob-объекту хранилища Azure, который будет содержать ошибки и журналы хода выполнения задания импорта.
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