Data Source Sharing Rules in DataWorks Explained - DataWorks - Alibaba Cloud - DataWorks

Operation description

This operation is available for all DataWorks editions.
To query the sharing rules of a data source associated with a workspace, you must have the data source sharing permissions in that workspace. You must have one of the following roles in DataWorks:

Tenant Owner, Tenant Administrator, Workspace Administrator, and Workspace Owner

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DataSourceId	integer	Yes	The data source ID.	1
TargetProjectId	integer	No	The ID of the workspace to which the data source is shared. You cannot share the data source to the workspace with which the data source is associated.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0000-ABCD-EFG****
DataSourceSharedRules	array<object>	The sharing rules of the data source.
	object	The sharing rule of the data source.
Id	integer	The rule ID.	1
DataSourceId	integer	The data source ID. You can call the ListDataSources operation to query the ID.	1
SharedDataSourceName	string	The name of the data source in the destination workspace.	targetProject.datasource
SourceProjectId	integer	The ID of the workspace with which the data source is associated.	1
TargetProjectId	integer	The ID of the workspace to which the data source is shared.	1
SharedUser	string	The user in the workspace to which the data source is shared. If the data source is shared to the entire workspace, this parameter is left empty.	1
EnvType	string	The environment to which the target data source belongs. The values are as follows: Dev: the development environment. Prod: the production environment.	Dev
CreateTime	integer	The time when the rule was created. This value is a UNIX timestamp.	1724379762000
CreateUser	string	The ID of the user who creates the rule.	1

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-EFG****",
  "DataSourceSharedRules": [
    {
      "Id": 101412,
      "DataSourceId": 265133,
      "SharedDataSourceName": "targetProject.datasource",
      "SourceProjectId": 106560,
      "TargetProjectId": 106561,
      "SharedUser": "1107550004253538",
      "EnvType": "Dev",
      "CreateTime": 1724379762000,
      "CreateUser": "1107550****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.