ListDataSources - DataWorks - Alibaba Cloud Documentation Center

Queries a list of data sources based on the business information of data sources.

Operation description

This API operation is available for all DataWorks editions.
You can call this operation only if you are assigned one of the following roles in DataWorks:

Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	Yes	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.	17820
Name	string	No	The name of the data source. Fuzzy match by data source name is supported.	test
Types	array	No	The data source types. This parameter specifies a filter condition. You can specify multiple data source types.
	string	No	The data source type.	mysql
EnvType	string	No	The environment in which the data sources are used. Valid values: Dev: development environment Prod: production environment	Prod
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
SortBy	string	No	The field that you want to use to sort the data sources. Valid values: CreateTime Id Name Default value: Id	Id
Order	string	No	The order in which you want to sort the data sources. Valid values: Desc: descending order Asc: ascending order Default value: Asc	Asc
Tags	string	No	The tag of the data source. This parameter specifies a filter condition. You can specify multiple tags, which are in the logical AND relation. For example, you can query the data sources that contain the following tags: `["tag1", "tag2", "tag3"]`. If you do not configure this parameter, tag-based filtering is not performed.	["tag1", "tag2", "tag3"]

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7BE1433F-6D55-5D86-9344-CA6F7DD19B13
PagingInfo	object	The pagination information.
TotalCount	long	The total number of entries returned.	131
PageSize	long	The number of entries per page.	10
PageNumber	long	The page number.	1
DataSources	array<object>	The data source groups. Each element in the array indicates a data source group. Each data source group contains data sources in the development environment (if any) and the production environment.
	object	The information about the data source group, including data sources in the development environment (if any) and the production environment. Data sources in the development environment and the production environment have the same data source name and data source type, but different data source IDs.
Name	string	The name of the data source.	test
Type	string	The type of the data source.	mysql
DataSource	array<object>	The data sources. Each element is the information of a single data source with a unique data source ID.
	object	The information about the data source.
Id	long	The ID of the data source.	16035
ConnectionProperties	any	The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter: Dev: development environment Prod: production environment The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see Data source connection information (ConnectionProperties).	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	The mode in which the data source is added. The mode varies based on the data source type. Valid values: InstanceMode, UrlMode, and CdhMode. The value InstanceMode indicates the instance mode. The value UrlMode indicates the connection string mode. The value CdhMode indicates the CDH cluster mode.	UrlMode
Description	string	The description of the data source.	test
CreateTime	long	The time when the data source was added. This value is a UNIX timestamp.	1648711113000
CreateUser	string	The ID of the user who adds the data source.	1624387842781448
ModifyTime	long	The time when the data source was last modified. This value is a UNIX timestamp.	1648711113000
ModifyUser	string	The ID of the user who modifies the data source.	1624387842781448
QualifiedName	string	The unique business key of the data source. For example, the unique business key of a Hologres data source is in the `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}` format.	1648711121000:cn-beijing:odps:yongxunQA_beijing_standard

Examples

Sample success responses

JSONformat

{
  "RequestId": "7BE1433F-6D55-5D86-9344-CA6F7DD19B13",
  "PagingInfo": {
    "TotalCount": 131,
    "PageSize": 10,
    "PageNumber": 1,
    "DataSources": [
      {
        "Name": "test",
        "Type": "mysql",
        "DataSource": [
          {
            "Id": 16035,
            "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": 1648711113000,
            "CreateUser": "1624387842781448",
            "ModifyTime": 1648711113000,
            "ModifyUser": "1624387842781448",
            "QualifiedName": "1648711121000:cn-beijing:odps:yongxunQA_beijing_standard"
          }
        ]
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history