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

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

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Sim	O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para obter o ID.	10000
DatasourceName	string	Sim	O nome da fonte de dados.	mysql_name
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas por página.	10
EnvType	string	Não	O ambiente no qual a fonte de dados reside. Valores válidos: 0: ambiente de desenvolvimento 1: ambiente de produção	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
RequestId	string	O ID da solicitação. Você pode localizar logs e solucionar problemas com base no ID.	0000-ABCD-EFG
Data	object	O resultado retornado.
Status	string	Indica se os metadados da fonte de dados foram obtidos. Valores válidos: success: Os metadados da fonte de dados foram obtidos. fail: Falha ao obter os metadados da fonte de dados. Você pode solucionar problemas com base no parâmetro Message.	success
Message	string	O motivo pelo qual os metadados da fonte de dados não foram obtidos. Se os metadados da fonte de dados forem obtidos, nenhum valor será retornado para este parâmetro.	read datasource time out
Meta	string	Os metadados retornados da fonte de dados. Os metadados retornados estão no formato JSON. `{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}` Descrição dos parâmetros: dbName: o nome do banco de dados no qual a fonte de dados reside. schema: o schema do banco de dados. enable: indica se o banco de dados está disponível. Os valores válidos são true e false. O valor true indica que o banco de dados está disponível. O valor false indica que o banco de dados está indisponível. tableName: o nome da tabela no banco de dados. tableInfos: as informações sobre a tabela no banco de dados.	{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}

Exemplos

Resposta de sucesso

JSON formato

{
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "Data": {
    "Status": "success",
    "Message": "read datasource time out",
    "Meta": "{\"dbTables\":[{\"dbName\":\"testdb\",\"schema\":[{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table1\",\"tableName\":\"table1\"}]},{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table2\",\"tableName\":\"table2\"}]}]}]}"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Invalid.DI.Parameter	The parameter is invalid.
500	InternalError.DI.Parameter	A DI internal error occurred.
403	Forbidden.DI.NoPrivilege	No access.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.