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

Consulta as informações básicas de uma metatabela.

Descrição da operação

前置条件：调用本接口前，请先开通 DataWorks 企业版或旗舰版；未开通时服务会返回 403 Forbidden.Access。

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 Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TableGuid	string	Não	O GUID da tabela do MaxCompute. Especifique o GUID no formato odps.projectName.tableName. Nota Este parâmetro é opcional para tabelas do E-MapReduce (EMR).	odps.engine_name.table_name
ClusterId	string	Não	O ID do cluster EMR. Este parâmetro é obrigatório apenas se você definir o parâmetro DataSourceType como emr. Você pode fazer login no console do EMR para consultar o ID.	abc
DatabaseName	string	Não	O nome do metadatabase. Este parâmetro é obrigatório apenas se você definir o parâmetro DataSourceType como emr. Você pode chamar a operação ListMetaDB para consultar o nome.	abc
TableName	string	Não	O nome da metatabela no cluster EMR. Este parâmetro é obrigatório apenas se você definir o parâmetro DataSourceType como emr. Você pode chamar a operação GetMetaDBTableList para consultar o nome.	abc
DataSourceType	string	Não	O tipo da fonte de dados. Valores válidos: odps e emr.	emr
Extension	boolean	Não	Especifica se devem ser incluídos campos estendidos nos resultados da consulta. Os campos estendidos incluem ReadCount, FavoriteCount e ViewCount. Este parâmetro só tem efeito se você definir o parâmetro DataSourceType como odps.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
RequestId	string	O ID da solicitação.	0bc1411515937
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Data	object	Os dados de negócios.
TableName	string	O nome da metatabela.	table_name
FavoriteCount	integer	O número de vezes que a metatabela foi adicionada a uma lista de favoritos. Este parâmetro é retornado apenas se você definir o parâmetro Extension como true e só tem efeito se você definir o parâmetro DataSourceType como odps.	6
Comment	string	O comentário da metatabela.	test table
ColumnCount	integer	O número de campos.	3
CreateTime	integer	A hora em que a metatabela foi criada.	1589870294000
ProjectId	integer	O ID do espaço de trabalho.	232
OwnerId	string	O ID do proprietário da metatabela.	123
EnvType	integer	O tipo de ambiente. Valores válidos: 0: ambiente de desenvolvimento 1: ambiente de produção	1
DatabaseName	string	O nome do metadatabase.	abc
IsVisible	integer	O escopo no qual a metatabela é visível. Valores válidos: 0: A metatabela é visível para os membros do espaço de trabalho. 1: A metatabela é visível para os usuários dentro do tenant. 2: A metatabela é visível para todos os tenants. 3: A metatabela é visível apenas para o proprietário da metatabela.	1
TableGuid	string	O GUID da metatabela.	odps.engine_name.table_name
ReadCount	integer	O número de vezes que a metatabela foi lida. Este parâmetro é retornado apenas se você definir o parâmetro Extension como true e só tem efeito se você definir o parâmetro DataSourceType como odps.	3
ClusterId	string	O ID do cluster EMR.	abc
IsPartitionTable	boolean	Indica se a metatabela é uma tabela particionada. Valores válidos: true false	true
IsView	boolean	Indica se a metatabela é uma view. Valores válidos: true false	false
LifeCycle	integer	O ciclo de vida da tabela. Unidade: dia. Nota Se o ciclo de vida não for definido para uma tabela do MaxCompute, o valor retornado será 0, indicando que a tabela é permanentemente válida.	5
ProjectName	string	O nome do espaço de trabalho.	test
ViewCount	integer	O número de vezes que a metatabela foi visualizada. Este parâmetro é retornado apenas se você definir o parâmetro Extension como true e só tem efeito se você definir o parâmetro DataSourceType como odps.	2
LastAccessTime	integer	A hora em que a metatabela foi acessada pela última vez.	1589870294000
DataSize	integer	O tamanho do espaço de armazenamento ocupado pela metatabela. Unidade: bytes.	10
LastModifyTime	integer	A hora em que a metatabela foi atualizada pela última vez.	1589870294000
LastDdlTime	integer	A hora em que o esquema da metatabela foi alterado pela última vez.	1589870294000
PartitionKeys	string	A chave de partição da metatabela do Hive.	ab
Location	string	O caminho de armazenamento do metadatabase do Hive.	hdfs://
Caption	string	O nome de exibição da metatabela.	Chinese name
TenantId	integer	O ID do tenant.	12345
Schema	string	As informações de esquema da metatabela. Este parâmetro é retornado se o modelo de três camadas do MaxCompute estiver ativado.	default

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0bc1411515937",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Data": {
    "TableName": "table_name",
    "FavoriteCount": 6,
    "Comment": "test table",
    "ColumnCount": 3,
    "CreateTime": 1589870294000,
    "ProjectId": 232,
    "OwnerId": "123",
    "EnvType": 1,
    "DatabaseName": "abc",
    "IsVisible": 1,
    "TableGuid": "odps.engine_name.table_name",
    "ReadCount": 3,
    "ClusterId": "abc",
    "IsPartitionTable": true,
    "IsView": false,
    "LifeCycle": 5,
    "ProjectName": "test",
    "ViewCount": 2,
    "LastAccessTime": 1589870294000,
    "DataSize": 10,
    "LastModifyTime": 1589870294000,
    "LastDdlTime": 1589870294000,
    "PartitionKeys": "ab",
    "Location": "hdfs://",
    "Caption": "中文名",
    "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 do aplicativo é 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 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 rede da interface está desconectada.
500	InternalError.Meta.Unknown	An unknown error occurred while processing your request.	Ocorreu um erro desconhecido.
403	Forbidden.Meta.NoTenant	The user is not the owner of any tenants.	O usuário atual não é o proprietário de nenhum locatário.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
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.