GetProjectRole - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a role in a DataWorks workspace.

Operation description

This API operation is available for all DataWorks editions.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:GetProjectRole	get	All Resources ``	none	none

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.	10002
Code	string	Yes	The code of the role in the DataWorks workspace. Valid values: role_project_admin: workspace administrator role_project_dev: developer role_project_dg_admin: data governance administrator role_project_guest: visitor role_project_security: security administrator role_project_deploy: deployer role_project_owner: workspace owner role_project_data_analyst: data analyst role_project_pe: O&M engineer role_project_erd: model designer	role_project_guest

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	82F28E60-CF48-5EDF-AB25-D806847B97D1
ProjectRole	object	The role in the DataWorks workspace.
ProjectId	long	The DataWorks workspace ID.	10002
Code	string	The code of the role in the DataWorks workspace.	role_project_guest
Name	string	The name of the role in the DataWorks workspace.	Visitors
Type	string	The type of the role in the DataWorks workspace. Valid values: UserCustom: user-defined role System: system role	System

Examples

Sample success responses

JSONformat

{
  "RequestId": "82F28E60-CF48-5EDF-AB25-D806847B97D1",
  "ProjectRole": {
    "ProjectId": 10002,
    "Code": "role_project_guest",
    "Name": "Visitors",
    "Type": "System"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history