Jobs - ImportJobs Cancel

Service:

Azure Digital Twins

API Version:

2023-10-31

Cancela un trabajo de importación que se está ejecutando actualmente. El servicio detendrá las operaciones de importación desencadenadas por el trabajo de importación actual que están en curso y pasarán a un estado cancelado. Tenga en cuenta que esto dejará la instancia en un estado desconocido, ya que no habrá ninguna operación de reversión. Códigos de estado:

• 200 Solicitud aceptada
• 400 - Solicitud incorrecta
  • ValidationFailed: la solicitud de trabajo de importación no es válida.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	string	Identificador del trabajo de importación. El identificador es único dentro del servicio y distingue mayúsculas de minúsculas.
api-version	query	True	string	La versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
traceparent		string	Identifica la solicitud en un sistema de seguimiento distribuido.
tracestate		string	Proporciona información de identificación de seguimiento específica del proveedor y es un complemento de traceparent.

Respuestas

Nombre	Tipo	Description
200 OK	ImportJob	Correcto
Other Status Codes	ErrorResponse	Respuesta predeterminada. Headers x-ms-error-code: string

Seguridad

oauth2

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

Ejemplos

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"
}

Definiciones

Nombre	Description
Error	Definición de error.
ErrorResponse	Respuesta de error.
ImportJob	Un trabajo que contiene una referencia a las operaciones para realizar, resultados y metadatos de ejecución.
InnerError	Una descripción de error más específica de la proporcionada por el error contenedor.
status	Estado del trabajo.

Error

Definición de error.

Nombre	Tipo	Description
code	string	Código de error específico del servicio que actúa como subestado para el código de error HTTP.
details	Error[]	Detalles internos del error.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	Error	Los detalles del error.

ImportJob

Un trabajo que contiene una referencia a las operaciones para realizar, resultados y metadatos de ejecución.

Nombre	Tipo	Description
createdDateTime	string	Hora de inicio del trabajo. La marca de tiempo está en RFC3339 formato: yyyy-MM-ddTHH:mm:ssZ.
error	Error	Detalles de los errores que se produjeron al ejecutar el trabajo de importación.
finishedDateTime	string	Hora de finalización del trabajo. La marca de tiempo está en RFC3339 formato: yyyy-MM-ddTHH:mm:ssZ.
id	string	Identificador del trabajo de importación.
inputBlobUri	string	Ruta de acceso al blob de Azure Storage de entrada que contiene archivos que describen las operaciones que se van a realizar en el trabajo.
lastActionDateTime	string	La última vez que el servicio realizó cualquier acción del trabajo. La marca de tiempo está en RFC3339 formato: yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	Ruta de acceso al blob de Azure Storage de salida que contendrá los errores y los registros de progreso del trabajo de importación.
purgeDateTime	string	Hora en la que el servicio purgará el trabajo desde el sistema. La marca de tiempo está en RFC3339 formato: yyyy-MM-ddTHH:mm:ssZ.
status	status	Estado del trabajo.

InnerError

Una descripción de error más específica de la proporcionada por el error contenedor.

Nombre	Tipo	Description
code	string	Código de error más específico del proporcionado por el error contenedor.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.

status

Estado del trabajo.

Nombre	Tipo	Description
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string