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

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID da entidade do banco de dados. Você pode consultar a resposta da operação ListDatabases e Conceitos relacionados a entidades de metadados. O formato: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. Use strings vazias como espaços reservados para níveis que não existem. Nota Para o StarRocks, o identificador do catálogo é o nome do catálogo. Para o DLF, o identificador do catálogo é o ID do catálogo. Para outros tipos, a hierarquia no nível do catálogo não é suportada, e uma string vazia pode ser usada como espaço reservado. Exemplos de formatos de ID comuns `dlf-database::catalog_id:database_name` `holo-database:instance_id::database_name` `mysql-database:(instance_id\|encoded_jdbc_url)::database_name` Nota `catalog_id`: O ID do catálogo DLF. `instance_id`: O ID da instância, que é necessário quando a fonte de dados é registrada no modo de instância. `encoded_jdbc_url`: A string de conexão JDBC codificada, que é necessária quando a fonte de dados é registrada no modo de string de conexão. `database_name`: O nome do banco de dados.	dlf-database::catalog_id:database_name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	1AFAE64E-D1BE-432B-A9****
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Database	Database	Os detalhes do banco de dados.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Database": {
    "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.