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

Consulta uma fonte de dados especificada pelo ID da fonte de dados.

Descrição da operação

Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar este recurso.
Você deve ter pelo menos uma das seguintes funções no workspace do DataWorks:

Tenant Owner, Workspace Administrator, Deployment, Developer, Project Owner ou O&M Engineer

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Sim	O ID da fonte de dados, que é o identificador exclusivo da fonte de dados.	16035

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação. Usado para localizar logs e solucionar problemas.	9252F32F-D855-549E-8898-61CF5A733050
DataSource	object	Os detalhes da fonte de dados.
Id	integer	O ID da fonte de dados.	16738
ProjectId	integer	O ID do workspace ao qual a fonte de dados pertence.	52660
Name	string	O nome da fonte de dados.	test
Type	string	O tipo da fonte de dados.	hologres
ConnectionProperties	any	A configuração de conexão da fonte de dados, incluindo o endpoint, a identidade de acesso e o contexto do ambiente. O tipo de ambiente da fonte de dados (envType) é uma propriedade membro deste objeto. Valores válidos: Dev: ambiente de desenvolvimento. Prod: ambiente de produção. Diferentes tipos de fontes de dados possuem especificações de propriedades distintas em diferentes modos de configuração (ConnectionPropertiesMode). Para mais informações, consulte Propriedades de conexão da fonte de dados (ConnectionProperties).	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	A categoria na qual a fonte de dados é adicionada. Diferentes tipos possuem subtipos distintos com restrições de parâmetros diferentes. Exemplos: InstanceMode: modo de instância. UrlMode: modo de string de conexão. CdhMode: modo CDH.	UrlMode
Description	string	A descrição da fonte de dados.	test
CreateTime	integer	A hora em que a fonte de dados foi criada (timestamp).	1698286929333
CreateUser	string	O ID do usuário que criou a fonte de dados.	1107550004253538
ModifyTime	integer	A hora em que a fonte de dados foi modificada pela última vez (timestamp).	1698286929333
ModifyUser	string	O ID do usuário que modificou a fonte de dados pela última vez.	1107550004253538
QualifiedName	string	A chave exclusiva de negócio da fonte de dados. Por exemplo, o formato para uma fonte de dados Hologres é `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`.	1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "DataSource": {
    "Id": 16738,
    "ProjectId": 52660,
    "Name": "test",
    "Type": "hologres",
    "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
    "ConnectionPropertiesMode": "UrlMode",
    "Description": "test",
    "CreateTime": 1698286929333,
    "CreateUser": "1107550004253538",
    "ModifyTime": 1698286929333,
    "ModifyUser": "1107550004253538",
    "QualifiedName": "1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb"
  }
}

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.