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

Obtém as informações básicas de metadados de uma instância de mecanismo.

Descrição da operação

Antes de começar: Ative o DataWorks Enterprise Edition ou Ultimate Edition antes de chamar esta operação. Se a edição não estiver ativada, o serviço retornará 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
AppGuid	string	Não	O ID do mecanismo, no formato `Tipo de mecanismo.Nome do mecanismo`.	odps.some_engine_name
ClusterId	string	Não	O ID do cluster EMR.	abc
DatabaseName	string	Não	O banco de dados do cluster EMR.	abc
DataSourceType	string	Não	O tipo de dados. Valores válidos: odps e emr.	emr

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	0bc1411515937****
Data	object	As informações básicas de metadados.
Type	string	O tipo de banco de dados.	hive
Comment	string	O comentário.	Comment
CreateTime	integer	A hora em que o mecanismo foi criado. O valor é um número de 13 dígitos, por exemplo, `1541576644000`.	1541576644000
ProjectId	integer	O ID do workspace.	22
ProjectName	string	O nome do workspace.	test
AppGuid	string	O ID do mecanismo, no formato `Tipo de mecanismo.Nome do mecanismo`.	odps.engine_name
OwnerName	string	O nome do proprietário do workspace.	my_name
OwnerId	string	O ID da conta Alibaba Cloud do proprietário do workspace.	userId
EnvType	integer	O tipo de ambiente. Um valor de 0 indica uma tabela de não produção. Um valor de 1 indica uma tabela de produção.	1
ProjectNameCn	string	O nome de exibição do workspace.	Test project
Endpoint	string	O endpoint do serviço.	http://service.odpsstg.aliyun-inc.com/
ClusterBizId	string	O ID do cluster EMR.	abc
Name	string	O nome do banco de dados.	abc
Location	string	O endereço de armazenamento de dados do banco de dados EMR.	hdfs://
TenantId	integer	O ID do locatário.	233
ModifyTime	integer	A hora em que o mecanismo foi modificado. O valor é um número de 13 dígitos, por exemplo, `1541576644000`.	1541576644000

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0bc1411515937****",
  "Data": {
    "Type": "hive",
    "Comment": "备注",
    "CreateTime": 1541576644000,
    "ProjectId": 22,
    "ProjectName": "test",
    "AppGuid": "odps.engine_name",
    "OwnerName": "my_name",
    "OwnerId": "userId",
    "EnvType": 1,
    "ProjectNameCn": "测试项目",
    "Endpoint": "http://service.odpsstg.aliyun-inc.com/",
    "ClusterBizId": "abc",
    "Name": "abc",
    "Location": "hdfs://",
    "TenantId": 233,
    "ModifyTime": 1541576644000
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Invalid.Meta.AppNotExist	The MaxCompute project does not exist.	O projeto MaxCompute 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	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.
400	InvalidParameter.Meta.NotExist	The data does not exist.	Os dados não existem.
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.