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

Consulta a configuração, o status e as informações da execução mais recente de um rastreador de metadados especificado.

Descrição da operação

Cenários

Consulta a configuração, o status de disponibilidade e as informações da execução mais recente de um rastreador de metadados especificado.

Fluxo de trabalho recomendado

Chame ListCrawlers para consultar os IDs dos rastreadores.
Chame esta operação para obter os detalhes do rastreador.
Para consultar o histórico completo de execuções, chame ListCrawlerRuns.

Requisitos de edição

É necessário o DataWorks Basic Edition ou superior.

Precauções

Se o rastreador não tiver sido executado, o status da execução mais recente e o ID da instância da tarefa podem estar vazios.

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.

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 este ID.	1234

Você pode chamar ListCrawlers para consultar o 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.
Crawler	object	Os detalhes do rastreador de metadados.
Id	integer	O ID do rastreador.	1234
Name	string	O nome do rastreador.	example_crawler
DataSourceId	integer	O ID da fonte de dados.	12345
Type	string	O tipo de rastreador.	starrocks
Status	string	O status do rastreador. O valor é VALID se a configuração do rastreador for válida e a fonte de dados associada existir. Caso contrário, o valor é INVALID.	VALID
MetaEntityId	string	O ID da metaentidade associada ao rastreador, que pode ser usado para conectar-se às APIs de consulta de metadados.	starrocks:example-instance
ProjectId	integer	O ID do workspace do DataWorks.	100
EnvType	string	O tipo de ambiente do DataWorks. Valores válidos: Dev, Prod.	Prod
ResourceGroupId	string	O ID do grupo de recursos Serverless 2.0 usado para executar a tarefa de coleta.	Serverless_res_group_1234567890123456_1234567890
ScheduleConfig	object	A configuração de agendamento.
Type	string		NORMAL
CronExpress	string		0 0 2 ? * *
LastRunStatus	string	O status da execução mais recente. Valores válidos: WAITING, RUNNING, SUCCESS, ERROR, SHUTDOWN. Este valor pode estar vazio se o rastreador não tiver sido executado.	SUCCESS
Owner	string	O ID de usuário do DataWorks do proprietário do rastreador.	1000
CreateTime	integer	A hora de criação, em timestamp UNIX de nível de milissegundo.	1710239005403
ModifyTime	integer	A hora de modificação, em timestamp UNIX de nível de milissegundo.	1710239005403
Scope	object	A configuração do escopo de coleta.
Unit	string		DATABASE
Items	array
	string		example_database
ExcludeRegex	string		^tmp_.*
EnableAiComment	boolean	Indica se a descrição de metadados por IA está ativada.
Options	object	A configuração estendida para o tipo de rastreador.
	string	O valor de um único item de configuração estendida para o rastreador.	true
LastRunTaskInstanceId	integer	O ID da instância da tarefa do DataWorks associado à execução mais recente. Este valor pode estar vazio se o rastreador não tiver sido executado.	1234
TaskId	integer	O ID da tarefa de agendamento do DataWorks associado ao rastreador, que pode ser usado para chamar GetTask e consultar a definição da tarefa.	1234

O objeto Crawler retorna a configuração do rastreador, o status de disponibilidade e as informações da execução mais recente.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "Crawler": {
    "Id": 1234,
    "Name": "example_crawler",
    "DataSourceId": 12345,
    "Type": "starrocks",
    "Status": "VALID",
    "MetaEntityId": "starrocks:example-instance",
    "ProjectId": 100,
    "EnvType": "Prod",
    "ResourceGroupId": "Serverless_res_group_1234567890123456_1234567890",
    "ScheduleConfig": {
      "Type": "NORMAL",
      "CronExpress": "0 0 2 ? * *"
    },
    "LastRunStatus": "SUCCESS",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "Scope": {
      "Unit": "DATABASE",
      "Items": [
        "example_database"
      ],
      "ExcludeRegex": "^tmp_.*"
    },
    "EnableAiComment": false,
    "Options": {
      "key": "true"
    },
    "LastRunTaskInstanceId": 1234,
    "TaskId": 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.