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

Consulta crawlers de metadados por consulta paginada e suporta filtragem por workspace, fonte de dados, tipo, ambiente, proprietário e nome.

Descrição da operação

Cenários

Realiza uma consulta paginada dos crawlers de metadados aos quais você tem acesso. Suporta filtragem por workspace, fonte de dados, tipo de crawler, ambiente, proprietário e nome.

Fluxo recomendado

Combine as condições de filtro conforme necessário para realizar uma consulta condicional da lista de crawlers.
Use os IDs de crawler retornados para invocar as operações de obter detalhes, atualizar, executar, parar, registros de execução ou excluir.

Requisitos de versão

É necessária a DataWorks Basic Edition ou superior.

Precauções

Quando várias condições de filtro são fornecidas ao mesmo tempo, elas entram em vigor combinadas. O campo de nome suporta correspondência difusa.

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:ListCrawlers

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do workspace do DataWorks.	100
DataSourceIds	array	Não	A lista de IDs de fontes de dados. São suportados até 10 IDs.
	integer	Não	O ID de uma única fonte de dados.	12345
Type	string	Não	O tipo de crawler. Chame GetCrawlerTypeCapabilities para consultar os valores válidos suportados na região atual.	starrocks
EnvType	string	Não	O tipo de ambiente do DataWorks. Dev indica o ambiente de desenvolvimento. Prod indica o ambiente de produção.	Prod
Owner	string	Não	O ID de usuário do DataWorks do proprietário do crawler.	1000
Name	string	Não	O nome do crawler de metadados. Suporta correspondência difusa.	example_crawler
PageNumber	integer	Não	O número da página. Começa em 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 20. Valor máximo: 100.	20

Quando várias condições de filtro são fornecidas ao mesmo tempo, elas entram em vigor combinadas. DataSourceIds suporta até 10 IDs.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado da 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.
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de registros que correspondem às condições de consulta.	1
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas por página.	20
Crawlers	array<object>	A lista de crawlers de metadados.
	array<object>	As informações resumidas de um crawler de metadados.
Id	integer	O ID do crawler.	1234
Name	string	O nome do crawler.	example_crawler
DataSourceId	integer	O ID da fonte de dados.	12345
Type	string	O tipo de crawler.	starrocks
Status	string	O status do crawler. O valor é VALID quando a configuração do crawler é válida e a fonte de dados associada existe. Caso contrário, o valor é INVALID.	VALID
MetaEntityId	string	O ID da metaentidade associada ao crawler. Você pode usar este ID para conectar-se a 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 rastreamento.	Serverless_res_group_1234567890123456_1234567890
ScheduleConfig	object	A configuração de agendamento.
Type	string	O tipo de agendamento. Valores válidos: MANUAL, NORMAL.	NORMAL
CronExpress	string	A expressão cron.	0 0 2 ? * *
LastRunStatus	string	O status da execução mais recente. Valores válidos: WAITING, RUNNING, SUCCESS, ERROR, SHUTDOWN. Este campo pode estar vazio se o crawler ainda não tiver sido executado.	SUCCESS
Owner	string	O ID de usuário do DataWorks do proprietário do crawler.	1000
CreateTime	integer	A hora de criação, expressa como um timestamp UNIX com precisão de milissegundos.	1710239005403
ModifyTime	integer	A hora de modificação, expressa como um timestamp UNIX com precisão de milissegundos.	1710239005403
TaskId	integer	O ID do nó de agendamento do DataWorks associado ao crawler. Você pode usar este ID para chamar GetTask e consultar a definição do nó.	1234

Crawlers retorna as informações resumidas dos crawlers de metadados na página atual.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "Success": false,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 20,
    "Crawlers": [
      {
        "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,
        "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.