GetDataSource API Reference & Parameters - DataWorks - Alibaba Cloud - DataWorks

Retrieves the details of a data source by data source ID.

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, Deployment, Development, Project Owner, and O&M

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The data source ID.	16035

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	9252F32F-D855-549E-8898-61CF5A733050
DataSource	object	The information about the data source.
Id	integer	The data source ID.	16738
ProjectId	integer	The ID of the workspace with which the data source is associated.	52660
Name	string	The name of the data source.	test
Type	string	The type of the data source.	hologres
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 CdhMode: CDH cluster 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.	1698286929333
CreateUser	string	The ID of the user who adds the data source.	1107550004253538
ModifyTime	integer	The time when the data source was last modified. This value is a UNIX timestamp.	1698286929333
ModifyUser	string	The ID of the user who modifies the data source.	1107550004253538
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.	1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.