Todos os produtos
Search
Central de documentação

DataWorks:DeleteSemanticJob

Última atualização: Sep 03, 2026

Exclui uma definição de job semântico pelo nome de um job criado. Se o job estiver em execução, chame KillSemanticJob com o ExecutorJobId dessa execução e confirme a parada antes da exclusão.

Descrição da operação

Cenários

Arquiva e exclui uma definição de job semântico salva para que ela não apareça mais na lista de jobs disponíveis.

Fluxo de chamada

  1. Obtenha o nome do job em CreateSemanticJob.Data.Name ou ListSemanticJobs.Data.SemanticJobs[].Name.

  2. Para verificar se existem execuções ativas, chame ListSemanticJobRuns primeiro. Se necessário, interrompa a execução chamando KillSemanticJob.

  3. Chame esta operação para excluir a definição do job.

Descrição do resultado

Uma resposta bem-sucedida indica que a solicitação de exclusão foi concluída. Após a exclusão, você não poderá mais usar o nome para chamar RunSemanticJob.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Name

string

Sim

O nome do job a ser excluído. Use o valor Data.Name da resposta de CreateSemanticJob ou o valor Name de um item da lista ListSemanticJobs.

semantic-job-demo

Construa os parâmetros de chamada com base na descrição de cada campo de solicitação.

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

A resposta padrão para exclusão de um job semântico. Data indica o resultado da exclusão do arquivo.

RequestId

string

O ID da solicitação. Usado para localizar logs e solucionar problemas.

676271D6-53B4-57BE-89FA-72F7AE1418DF

Success

boolean

Indica se a solicitação foi bem-sucedida.

Data

object

O resultado da exclusão do job. Uma exclusão não retorna uma definição de job que possa continuar em execução.

Id

integer

O ID único interno da definição de job excluída.

1

JobName

string

O nome original do job antes da exclusão, que é o Name especificado nesta solicitação.

semantic-job-demo

ArchivedJobName

string

O nome do job gerado pelo sistema para o registro de arquivamento. Este nome é usado apenas para distinguir registros excluídos e não pode ser usado para RunSemanticJob.

semantic-job-demo-archived

Deleted

boolean

Indica se a exclusão foi concluída. Um valor true indica que o job foi arquivado e excluído.

Para o significado dos campos de resposta e suas relações com chamadas subsequentes, consulte a descrição de cada campo.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "Id": 1,
    "JobName": "semantic-job-demo",
    "ArchivedJobName": "semantic-job-demo-archived",
    "Deleted": false
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.