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

Consulta uma lista de catálogos no Data Map. Somente catálogos dos tipos de crawler de metadados Data Lake Formation (DLF) e StarRocks são suportados. Para o tipo de crawler de metadados DLF, todos os catálogos de dados suportados são retornados. Para o tipo de crawler de metadados StarRocks, os catálogos de dados de uma instância específica são retornados.

Descrição da operação

É necessário o DataWorks Basic Edition ou uma edição superior.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ParentMetaEntityId	string	Sim	O ID da entidade pai. Para mais informações, consulte Conceitos relacionados a entidades de metadados. Atualmente, somente os tipos DLF e StarRocks são suportados. Para o tipo DLF, você pode consultar todas as listas de catálogos. O formato de `ParentMetaEntityId` é `DLF`. Para o tipo StarRocks, você pode consultar os catálogos de uma instância específica. O formato de `ParentMetaEntityId` é `StarRocks:(instance_id\|encoded_jdbc_url)`. Nota `instance_id`: O ID da instância. Obrigatório se a fonte de dados estiver registrada no modo de instância. `encoded_jdbc_url`: A string de conexão JDBC codificada com codificação URL. Obrigatório se a fonte de dados estiver registrada no modo de string de conexão.	dlf
Name	string	Não	O nome. Suporta correspondência aproximada.	abc
Comment	string	Não	O comentário. Suporta correspondência baseada em tokens.	this is a comment
Types	array	Não	O tipo. Suporta correspondência exata. Se deixado vazio, todos os tipos são consultados.
	string	Não	O tipo de catálogo.	HIVE
SortBy	string	Não	O campo de ordenação. Valor padrão: CreateTime. Valores válidos: CreateTime ModifyTime Name Type.	CreateTime
Order	string	Não	A ordem na qual as tabelas são classificadas. Valor padrão: Asc. Valores válidos: Asc: ordem crescente. Desc: ordem decrescente.	Asc
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de registros por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Respostas.
RequestId	string	O ID da solicitação.	317CD7D0-AB36-XXXXXX
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
PagingInfo	object	O resultado da paginação.
TotalCount	integer	O número total de registros.	1
PageNumber	integer	O número da página.	1
PageSize	integer	O número de registros por página.	10
Catalogs	array	O catálogo.
	Catalog	Os detalhes do catálogo.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "317CD7D0-AB36-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Catalogs": [
      {
        "Id": "dlf-catalog:123456XXX:test_catalog\nstarrocks-catalog:c-abc123xxx:default_catalog",
        "Name": "default_catalog",
        "Comment": "this is a comment\n",
        "Type": "Internal",
        "CreateTime": 1722073854000,
        "ModifyTime": 1722073854000,
        "ParentMetaEntityId": "dlf\nstarrocks:c-abc123xxx"
      }
    ]
  }
}

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.