Use ListDataSources API to Query Data Sources - DataWorks - Alibaba Cloud - DataWorks

Retrieves a list of data sources that match the specified filter conditions.

Operation description

This operation is available for all DataWorks editions.
To call this operation, you must have 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

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:ListDataSources

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	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: CreateTime	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: Desc	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. You can specify up to 10 tags.	["tag1", "tag2", "tag3"]

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7BE1433F-6D55-5D86-9344-CA6F7DD19B13
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	131
PageSize	integer	The number of entries per page.	10
PageNumber	integer	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.
	array<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	integer	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: instance mode UrlMode: connection string mode	UrlMode
Description	string	The description of the data source.	test
CreateTime	integer	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	integer	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

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.