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

Consulta as fontes de dados adicionadas a um espaço de trabalho do DataWorks.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

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 ao qual as fontes de dados pertencem. Você pode chamar a operação ListProjects para consultar o ID.	1
Name	string	Não	O nome da fonte de dados que você deseja consultar.	test
DataSourceType	string	Não	O tipo da fonte de dados. Os valores comuns incluem: odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
SubType	string	Não	O subtipo da fonte de dados. Este parâmetro só entra em vigor quando o parâmetro DataSourceType é definido como rds. Se o valor do parâmetro DataSourceType for rds, o valor deste parâmetro poderá ser mysql, sqlserver ou postgresql.	mysql
Status	string	Não	O status da fonte de dados. Valores válidos: ENABLED: normal. DISABLED: desativado.	ENABLED
EnvType	integer	Não	O ambiente no qual a fonte de dados é usada. Valores válidos: 0 e 1. O valor 0 indica o ambiente de desenvolvimento. O valor 1 indica o ambiente de produção.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
PageNumber	integer	Não	O número da página. As páginas começam na página 1.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
RequestId	string	O ID da solicitação.	0bc14115159376359****
Success	boolean	Indica se a solicitação foi bem-sucedida.	true
Data	object	O resultado da consulta retornado.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	20
TotalCount	integer	O número total de fontes de dados.	233
DataSources	array<object>	As fontes de dados.
	object	As informações sobre a fonte de dados.
Status	integer	O status da fonte de dados. Valores válidos: 1: A fonte de dados está em uso normal. 2: A fonte de dados está desativada.	1
ProjectId	integer	O ID do espaço de trabalho ao qual a fonte de dados pertence.	123
SubType	string	O subtipo da fonte de dados. Este parâmetro só entra em vigor quando o parâmetro DataSourceType é definido como rds.	mysql
GmtModified	string	A hora em que a fonte de dados foi modificada pela última vez. Exemplo: 17 de março de 2021 16:09:32.	Mar 17, 2021 4:09:32 PM
EnvType	integer	O ambiente no qual a fonte de dados é usada. Valores válidos: 0: ambiente de desenvolvimento 1: ambiente de produção	1
ConnectStatus	integer	O status da fonte de dados. Valores válidos: 1: A fonte de dados está em uso normal. 2: A fonte de dados está desativada.	1
Sequence	integer	O número de sequência da fonte de dados. As fontes de dados são classificadas em ordem decrescente com base no valor deste parâmetro.	300
Description	string	A descrição da fonte de dados.	a connection
DataSourceType	string	O tipo da fonte de dados. Os valores comuns incluem: odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
GmtCreate	string	A hora em que a fonte de dados foi criada. Exemplo: 17 de março de 2021 16:09:32.	Mar 17, 2021 4:09:32 PM
DefaultEngine	boolean	Indica se o mecanismo de computação associado à fonte de dados é o mecanismo de computação padrão usado por fontes de dados do mesmo tipo.	false
Shared	boolean	Indica se a fonte de dados é uma fonte de dados compartilhada.	false
Operator	string	O ID da conta Alibaba Cloud que foi usada para modificar a fonte de dados pela última vez.	193543050****
Name	string	O nome da fonte de dados.	abc
Content	string	A string de conexão de dados. O valor deste parâmetro está no formato JSON. Exemplos de strings de conexão de fontes de dados comuns: MaxCompute `{ "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api", "accessId": "xxxxxxx", "securityToken": null, "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api", "accessKey": "*", "name": "PRE_PROJECT_A_engine", "project": "PRE_PROJECT_A", "vpcEndpoint": "http://service.cn.maxcompute.aliyun-inc.com/api", "region": "cn-shanghai", "authType": "2" }` mysql `{ "configType": "1", "database": "mysql_d111b", "instanceName": "rm-xxxxxx", "password": "", "rdsOwnerId": "12133xxxxxx", "tag": "rds", "username": "mysql_db111" }` sqlserver `{ "configType": "1", "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1", "password": "", "tag": "public", "username": "sqlserver_db111" }` oss `{ "accessId": "*******", "accessKey": "*******", "bucket": "bigxxx1223", "configType": "1", "endpoint": "http://oss-cn-hangzhou.aliyuncs.com", "tag": "public" }` postgresql `{ "configType": "1", "database": "cdp_xxx", "instanceName": "rm-xxxx", "password": "", "rdsOwnerId": "121xxxxx", "tag": "rds", "username": "cdp_xxx" }` ads `{ "configType": "1", "password": "**", "schema": "ads_demo", "tag": "public", "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029", "username": "lslslsls" }`	{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}
Id	integer	O ID da fonte de dados.	1
BindingCalcEngineId	integer	O ID do mecanismo de computação ao qual a fonte de dados está associada.	123
TenantId	integer	O ID do locatário.	1234567

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "RequestId": "0bc14115159376359****",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 233,
    "DataSources": [
      {
        "Status": 1,
        "ProjectId": 123,
        "SubType": "mysql",
        "GmtModified": "Mar 17, 2021 4:09:32 PM",
        "EnvType": 1,
        "ConnectStatus": 1,
        "Sequence": 300,
        "Description": "a connection",
        "DataSourceType": "rds",
        "GmtCreate": "Mar 17, 2021 4:09:32 PM",
        "DefaultEngine": false,
        "Shared": false,
        "Operator": "193543050****",
        "Name": "abc",
        "Content": "{\"pubEndpoint\":\"http://service.cn.maxcompute.aliyun.com/api\",\"accessId\":\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\",\"securityToken\":null,\"endpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"accessKey\":\"***\",\"name\":\"PRE_PROJECT_A_engine\",\"project\":\"PRE_PROJECT_A\",\"vpcEndpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"region\":\"cn-shanghai\",\"authType\":\"2\"}",
        "Id": 1,
        "BindingCalcEngineId": 123,
        "TenantId": 1234567
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.