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

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID da entidade do catálogo de dados. Atualmente, os tipos DLF e StarRocks são suportados. Para mais informações, consulte a resposta da operação ListCatalogs e Conceitos de entidades de metadados. Para o tipo DLF, o formato é `dlf-catalog::catalog_id`. Para o tipo StarRocks, o formato é `starrocks-catalog:(instance_id\|encoded_jdbc_url):catalog_name`. Nota Onde: `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 por URL, que é necessária quando a fonte de dados é registrada por meio de uma string de conexão. `catalog_name`: o nome do catálogo StarRocks.	dlf-catalog::catalog_id

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
Catalog	Catalog	As informações do catálogo de dados.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "Success": true,
  "Catalog": {
    "Id": "dlf-catalog::catalog1",
    "Name": "catalog1",
    "Comment": "Catálogo padrão",
    "Type": "HIVE",
    "CreateTime": 1725330777000,
    "ModifyTime": 1725330777000,
    "ParentMetaEntityId": "dlf"
  }
}

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.