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

Consulta a lista de esquemas em um banco de dados ou projeto MaxCompute especificado no Data Map. Atualmente, suporta os tipos MaxCompute e Holo.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou superior para usar este recurso.

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

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. Para o tipo de rastreador de metadados do Hologres, você pode chamar a operação ListDatabases para consultar as configurações do parâmetro ParentMetaEntityId. Configure o parâmetro ParentMetaEntityId no formato ${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}. Se um nível não existir, deixe o nível vazio. Nota Se você quiser consultar as informações sobre um esquema do MaxCompute, especifique uma string vazia no nível de ID da instância como um espaço reservado e um nome de projeto do MaxCompute no nível de nome do banco de dados. Certifique-se de que o recurso de esquema esteja ativado para o projeto do MaxCompute. Formatos comuns de ParentMetaEntityId: maxcompute-project:::project_name: O projeto do MaxCompute deve ter o recurso de esquema ativado. holo-database:instance_id::database_name instance_id: ID da instância do Hologres. database_name: nome do banco de dados. project_name: nome do projeto do MaxCompute.	maxcompute-project:::project_name
Name	string	Não	O nome. Há suporte para correspondência aproximada.	abc
Comment	string	Não	O comentário. Há suporte para correspondência aproximada.	test comment
Types	array	Não	Os tipos. Há suporte para correspondência exata. Se este parâmetro for deixado vazio, todos os tipos serão consultados.
	string	Não	O tipo de esquema.	MANAGED
SortBy	string	Não	O campo usado para classificação. Valor padrão: CreateTime. Valores válidos: CreateTime ModifyTime Name Type	CreateTime
Order	string	Não	A ordem em que os esquemas são classificados. 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 entradas por página. Valor padrão: 10. Valor máximo: 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	235BBA5E-3428-XXXXXX
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
PagingInfo	object	As informações de paginação.
TotalCount	integer	O número total de entradas.	1
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
Schemas	array	Os esquemas.
	Schema	O esquema.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "235BBA5E-3428-XXXXXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 10,
    "Schemas": [
      {
        "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.