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

Descrição da operação

É necessária a edição Basic do DataWorks ou uma edição superior.
Somente os tipos MaxCompute e Hologres são suportados.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	string	Sim	O ID. Você pode consultar a operação ListSchemas e Conceitos relacionados a entidades de metadados. O formato é `${EntityType}:${Instance ID or escaped URL}:${Catalog ID}:${Database name}:${Schema name}`. Use strings vazias como espaços reservados para níveis ausentes. Nota Para o tipo MaxCompute, use uma string vazia como espaço reservado para o nível de ID da instância. O nome do banco de dados é o nome do projeto MaxCompute, e o projeto deve ter o modelo de três níveis ativado. Exemplos: `maxcompute-schema:::project_name:schema_name` (O modelo de três níveis está ativado para o projeto MaxCompute.) `holo-schema:instance_id::database_name:schema_name` Nota <br>`instance_id`: O ID da instância Hologres<br> . `database_name`: O nome do banco de dados<br> . `project_name`: O nome do projeto MaxCompute<br> . `schema_name`: O nome do esquema.	maxcompute-schema:::project_name:schema_name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	A89B5D9D-74EA-XXXXXX
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Schema	Schema	As informações do esquema.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A89B5D9D-74EA-XXXXXX",
  "Success": true,
  "Schema": {
    "Id": "maxcompute-schema:123456XXX::test_project:default\nholo-schema:h-abc123xxx::test_db:test_schema",
    "Name": "test_db",
    "Comment": "test comment",
    "Type": "MANAGED",
    "ParentMetaEntityId": "maxcompute-project:123456XXX::test_project\nholo-database:h-abc123xxx::test_db",
    "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.