ListDataSources

Queries the data sources added to a DataWorks workspace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace to which the data sources belong. You can call the ListProjects operation to query the ID.	1
Name	string	No	The name of the data source that you want to query.	test
DataSourceType	string	No	The type of the data source. Common values include: odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
SubType	string	No	The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds. If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.	mysql
Status	string	No	The status of the data source. Valid values: ENABLED: normal. DISABLED: disabled.	ENABLED
EnvType	integer	No	The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates development environment. The value 1 indicates production environment.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
PageNumber	integer	No	The page number. Pages start from page 1.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	0bc14115159376359****
Success	boolean	Indicates whether the request was successful.	true
Data	object	The query result returned.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of data sources.	233
DataSources	array<object>	The data sources.
	object	The information about the data source.
Status	integer	The status of the data source. Valid values: 1: The data source is in normal use. 2: The data source is disabled.	1
ProjectId	integer	The ID of the workspace to which the data source belongs.	123
SubType	string	The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.	mysql
GmtModified	string	The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.	Mar 17, 2021 4:09:32 PM
EnvType	integer	The environment in which the data source is used. Valid values: 0: development environment 1: production environment	1
ConnectStatus	integer	The status of the data source. Valid values: 1: The data source is in normal use. 2: The data source is disabled.	1
Sequence	integer	The sequence number of the data source. Data sources are sorted in descending order based on the value of this parameter.	300
Description	string	The description of the data source.	a connection
DataSourceType	string	The type of the data source. Common values include: odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
GmtCreate	string	The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.	Mar 17, 2021 4:09:32 PM
DefaultEngine	boolean	Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type.	false
Shared	boolean	Indicates whether the data source is a shared data source.	false
Operator	string	The ID of the Alibaba Cloud account that is used to last modify the data source.	193543050****
Name	string	The name of the data source.	abc
Content	string	The data connection string. The value of this parameter is in the JSON format. Examples of connection strings of common data sources: 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	The data source ID.	1
BindingCalcEngineId	integer	The ID of the compute engine with which the data source is associated.	123
TenantId	integer	The tenant ID.	1234567

Examples

Success response

JSON format

{
  "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
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	The user is not in the project.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	The user is not in tenant.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.