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

Pesquisa tabelas com base em condições especificadas.

Descrição da operação

Somente tabelas dos mecanismos MaxCompute e EMR são suportadas.

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

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página para a consulta paginada.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valor máximo: 100.	10
AppGuid	string	Não	O identificador do workspace ao qual a tabela pertence.	odps.engine_name
Keyword	string	Sim	A palavra-chave usada para pesquisar nomes de tabelas usando um algoritmo de correspondência de tokenização. Se nenhum campo correspondente for encontrado, null será retornado. Por padrão, a pesquisa é realizada com base na tokenização por sublinhado.	test
EntityType	integer	Não	O tipo da tabela. Valores válidos: 0: tabela. 1: view. Se você não especificar este parâmetro, tabelas de todos os tipos serão pesquisadas por padrão.	0
ClusterId	string	Não	O ID do cluster EMR. Este parâmetro é obrigatório apenas quando o tipo de fonte de dados é EMR. Você pode fazer login no console do EMR para obter o ID do cluster.	abc
DataSourceType	string	Não	O tipo de fonte de dados. Valores válidos: ODPS e emr.	emr
Schema	string	Não	As informações de schema da tabela. Se o modelo de três níveis estiver ativado para o MaxCompute, você deverá especificar as informações de schema.	default

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The specified parameters are invalid.
RequestId	string	O ID da solicitação.	0bc1ec92159376****
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrorCode	string	O código de erro.	1031203110005
Data	object	Os resultados da pesquisa.
PageNumber	integer	O número da página para a consulta paginada.	1
PageSize	integer	O número de entradas por página para a consulta paginada.	10
TotalCount	integer	O número total de tabelas.	100
DataEntityList	array<object>	A lista de tabelas retornada pela consulta.
	object	Os detalhes da tabela.
TableName	string	O nome da tabela.	test_name
DatabaseName	string	O nome do banco de dados.	abc
EntityType	integer	O tipo da tabela. Valores válidos: 0: tabela. 1: view.	0
ProjectName	string	O nome do workspace.	test
ProjectId	integer	O ID do workspace.	323
TableGuid	string	O identificador exclusivo da tabela.	odps.engine_name.test_name
OwnerId	string	O ID da conta Alibaba Cloud do proprietário do workspace.	123
ClusterId	string	O ID do cluster EMR.	abc
EnvType	integer	O tipo de ambiente. Valores válidos: 1: ambiente de produção. 0: ambiente de desenvolvimento.	1
TenantId	integer	O ID do tenant.	12345
Schema	string	As informações de schema da tabela. Se o modelo de três níveis estiver ativado para o MaxCompute, você deverá especificar as informações de schema.	default

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The specified parameters are invalid.",
  "RequestId": "0bc1ec92159376****",
  "Success": true,
  "ErrorCode": "1031203110005",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "DataEntityList": [
      {
        "TableName": "test_name",
        "DatabaseName": "abc",
        "EntityType": 0,
        "ProjectName": "test",
        "ProjectId": 323,
        "TableGuid": "odps.engine_name.test_name",
        "OwnerId": "123",
        "ClusterId": "abc",
        "EnvType": 1,
        "TenantId": 12345,
        "Schema": "default"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Meta.TableNotExist	The table does not exist.	A tabela não existe.
400	InvalidParameter.Meta.CommonError	The specified parameter is invalid.	O parâmetro da solicitação é inválido.
400	InvalidParameter.Meta.Illegal	The app guid parameter is invalid.	O parâmetro App é inválido.
400	InvalidParameter.Meta.IllegalDate	The date format is invalid.	O formato de data é inválido.
400	InvalidParameter.Meta.IllegalPageError	The parameter for paging is invalid.	As informações de paginação são inválidas.
400	InvalidParameter.Meta.NotExist	The object does not exist.
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
400	InternalError.Meta.NoCalcEngine	An error occurred while retrieving the compute engine based on the MaxCompute project.	O projeto especificado pelo usuário está incorreto.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.Meta.TenantTimeOut	Failed to connect to the interface network.	A API não está acessível pela rede.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	Ocorreu um erro desconhecido.
403	ResourceNotAuthorized.Api	You are not authorized to access the resources.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	O usuário atual não é o proprietário de nenhum tenant.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Você não tem as permissões necessárias. Conceda as permissões primeiro.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.