GetProjectRole-阿里云帮助中心

Queries the details of a workspace role.

Operation description

You can call this operation only if you have purchased DataWorks Basic Edition or a later edition.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.	10002
Code	string	Yes	The code of the workspace role. Valid values: role_project_admin: workspace administrator role_project_dev: developer role_project_dg_admin: data governance administrator role_project_guest: guest 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 elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	82F28E60-CF48-5EDF-AB25-D806847B97D1
ProjectRole	object	The details of the workspace role.
ProjectId	integer	The ID of the DataWorks workspace. Note: A fixed value of -1 is returned for a system role.	10002
Code	string	The code of the workspace role.	role_project_guest
Name	string	The name of the workspace role.	Visitors
Type	string	The type of the workspace role. Valid values: UserCustom: a custom role System: a system role	System
ModulePermissions	array<object>	The permissions for the modules in the workspace.
	object
ModuleId	integer	The module ID.	2
ModuleName	string	The module name.	HoloStudio
PermissionType	string	The permission type.	Read

Examples

Success response

JSON format

{
  "RequestId": "82F28E60-CF48-5EDF-AB25-D806847B97D1",
  "ProjectRole": {
    "ProjectId": 10002,
    "Code": "role_project_guest",
    "Name": "Visitors",
    "Type": "System",
    "ModulePermissions": [
      {
        "ModuleId": 2,
        "ModuleName": "HoloStudio",
        "PermissionType": "Read"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.