Compartilhar via


Jobs - ImportJobs Cancel

Cancela um trabalho de importação que está em execução no momento. O serviço interromperá todas as operações de importação disparadas pelo trabalho de importação atual em andamento e irá para um estado cancelado. Observe que isso deixará sua instância em um estado desconhecido, pois não haverá nenhuma operação de reversão. Códigos de status:

  • 200 Solicitação Aceita
  • 400 Solicitação Inválida
    • ValidationFailed - A solicitação de trabalho de importação não é válida.
POST https://digitaltwins-hostname/jobs/imports/{id}/cancel?api-version=2023-10-31

Parâmetros de URI

Nome Em Obrigatório Tipo Description
id
path True

string

A ID do trabalho de importação. A ID é exclusiva dentro do serviço e diferencia maiúsculas de minúsculas.

api-version
query True

string

A versão da API solicitada.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
traceparent

string

Identifica a solicitação em um sistema de rastreamento distribuído.

tracestate

string

Fornece informações de identificação de rastreamento específicas do fornecedor e é um complemento ao rastreamentoparente.

Respostas

Nome Tipo Description
200 OK

ImportJob

Êxito

Other Status Codes

ErrorResponse

Resposta padrão.

Headers

x-ms-error-code: string

Segurança

oauth2

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

Exemplos

Cancel a job

Sample Request

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

Sample Response

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

Definições

Nome Description
Error

Definição de erro.

ErrorResponse

Resposta de erro.

ImportJob

Um trabalho que contém uma referência às operações a serem executadas, resultados e metadados de execução.

InnerError

Uma descrição de erro mais específica do que foi fornecida pelo erro que o contém.

status

Status do trabalho.

Error

Definição de erro.

Nome Tipo Description
code

string

Código de erro específico do serviço que serve como substatus para o código de erro HTTP.

details

Error[]

Detalhes do erro interno.

innererror

InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

message

string

Uma representação legível do erro.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error

Error

Os detalhes do erro.

ImportJob

Um trabalho que contém uma referência às operações a serem executadas, resultados e metadados de execução.

Nome Tipo Description
createdDateTime

string

Hora de início do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

error

Error

Detalhes dos erros que ocorreram ao executar o trabalho de importação.

finishedDateTime

string

Hora de término do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

id

string

O identificador do trabalho de importação.

inputBlobUri

string

O caminho para o blob de armazenamento do Azure de entrada que contém arquivos que descrevem as operações a serem executadas no trabalho.

lastActionDateTime

string

Última vez que o serviço executou qualquer ação do trabalho. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

outputBlobUri

string

O caminho para o blob de armazenamento do Azure de saída que conterá os erros e os logs de progresso do trabalho de importação.

purgeDateTime

string

Hora em que o trabalho será limpo pelo serviço do sistema. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

status

status

Status do trabalho.

InnerError

Uma descrição de erro mais específica do que foi fornecida pelo erro que o contém.

Nome Tipo Description
code

string

Um código de erro mais específico do que foi fornecido pelo erro que o contém.

innererror

InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

status

Status do trabalho.

Nome Tipo Description
cancelled

string

cancelling

string

failed

string

notstarted

string

running

string

succeeded

string