RunCrawler - DataWorks: Central de Documentação do Alibaba Cloud

Descrição da operação

Cenários

Envia uma solicitação de execução para um rastreador de metadados especificado.

Processo recomendado

Chame ListCrawlers para consultar os IDs dos rastreadores disponíveis.
Chame esta operação para enviar uma solicitação de execução.
Chame ListCrawlerRuns para consultar o status final da execução.

Requisitos de edição

É necessário o DataWorks Basic Edition ou superior.

Descrição de cobrança

A execução de uma tarefa de coleta consome recursos de computação e pode gerar taxas. As taxas reais dependem do grupo de recursos utilizado e das regras de cobrança do DataWorks.

Se o rastreador tiver o recurso de descrição de metadados de IA ativado (EnableAiComment=true), a coleta de metadados e a geração de descrições de IA consomem tokens. Para obter informações sobre a cota gratuita de tokens e as regras de cobrança após a cota ser excedida, consulte Cobrança do Data Agent.

Precauções

Uma resposta bem-sucedida indica apenas que a solicitação de execução foi aceita. Não indica que a tarefa de coleta foi concluída.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:RunCrawler

update

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Sim	O ID do rastreador de metadados. Você pode chamar ListCrawlers para consultar o ID.	1234

Você pode chamar ListCrawlers para consultar o parâmetro Id.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação. Usado para localizar logs e solucionar problemas.	9252F32F-D855-549E-8898-61CF5A733050
Success	boolean	Indica se a solicitação foi bem-sucedida.
Id	integer	O ID do rastreador de metadados.	1234
RunAccepted	boolean	Indica se a solicitação de execução foi aceita. Um valor true indica que a solicitação foi aceita, mas não indica que a tarefa de coleta foi concluída.
RunStatus	string	O status inicial da execução após o envio. O valor é WAITING quando a solicitação de execução é aceita com sucesso. Para consultar o status final, chame ListCrawlerRuns.	WAITING
TaskInstanceId	integer	O ID da instância de tarefa do DataWorks associada. Este campo pode estar vazio. Para consultar o registro final da execução, chame ListCrawlerRuns.	1234

RunAccepted indica se a solicitação de execução foi aceita. Chame ListCrawlerRuns para consultar o status final. TaskInstanceId pode estar vazio.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "Id": 1234,
  "RunAccepted": false,
  "RunStatus": "WAITING",
  "TaskInstanceId": 1234
}

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.