ListDataSourceSharedRules - DataWorks - Alibaba Cloud Documentation Center

Queries a list of sharing rules of a data source.

Operation description

This API operation is available for all DataWorks editions.
If you want to query the sharing rules of a data source that is associated with Workspace A, you must have the permissions to share the data source in Workspace A. You can call this operation only if you are assigned one of the following roles in DataWorks:

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

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListDataSourceSharedRules	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DataSourceId	long	Yes	The data source ID.	1
TargetProjectId	long	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 parameters

Parameter	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	long	The rule ID.	1
DataSourceId	long	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	long	The ID of the workspace with which the data source is associated.	1
TargetProjectId	long	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
CreateTime	long	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

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history