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

Consulta uma lista de bancos de dados em uma instância, cluster ou catálogo de dados no Data Map. Para fontes de dados DLF ou StarRocks, você pode chamar esta operação de API para consultar bancos de dados em um catálogo de dados. Para fontes de dados StarRocks, você pode chamar esta operação de API para consultar bancos de dados apenas no Internal Catalog. Para outros tipos de fontes de dados, você pode chamar esta operação de API para consultar bancos de dados em uma instância ou cluster.

Descrição da operação

É necessário o DataWorks Basic Edition ou uma edição superior.
Para o tipo StarRocks, apenas o Internal Catalog é compatível.

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

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 obter mais informações, consulte Conceitos relacionados a entidades de metadados. Você pode consultar a operação ListCrawlerTypes para obter o tipo de entidade pai. Se a entidade pai for um catálogo, o formato de ParentMetaEntityId segue a resposta da API ListCatalogs. Se a entidade pai for um rastreador de metadados, o formato de ParentMetaEntityId é ${CrawlerType}:${Instance ID or encoded URL}. Exemplos de formato do ParentMetaEntityId dlf-catalog::catalog_id holo:instance_id mysql:(instance_id\|encoded_jdbc_url) Nota catalog_id: O ID do catálogo DLF. instance_id: O ID da instância. Obrigatório quando a fonte de dados é registrada no modo de instância. encoded_jdbc_url: A string de conexão JDBC codificada por URL. Obrigatória quando a fonte de dados é registrada por string de conexão.	holo:instance_id
Name	string	Não	O nome. Suporta correspondência aproximada.	test_tbl
Comment	string	Não	O comentário. Suporta correspondência aproximada.	test comment
SortBy	string	Não	O campo de ordenação. Valor padrão: CreateTime. Valores válidos: CreateTime ModifyTime Name	CreateTime
Order	string	Não	A ordem de classificação. Valor padrão: Asc. Valores válidos: Asc: ascendente. Desc: descendente.	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. Máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	9DD08926-38B9-XXXXXXX
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
Databases	array	A lista de bancos de dados.
	Database	As informações do banco de dados.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9DD08926-38B9-XXXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Databases": [
      {
        "Id": "holo-database:h-xxxx::test_db",
        "Name": "test_db",
        "Comment": "test comment",
        "LocationUri": "oss://test-bucket/test_db",
        "ParentMetaEntityId": "holo:h-xxxx",
        "CreateTime": 1736852168000,
        "ModifyTime": 1736852168000
      }
    ]
  }
}

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.