All Products
Search
Document Center

DataWorks:ListProjectRoles

Last Updated:Sep 18, 2024

Queries a list of roles in a DataWorks workspace.

Operation description

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:ListProjectRolesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The ID of the DataWorks workspace.

27

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AFAE64E-D1BE-432B-A9****
ProjectRoleListarray<object>

The roles in the DataWorks workspace.

object
ProjectRoleIdinteger

The ID of the role in the DataWorks workspace.

1
ProjectRoleTypestring

The type of the role in the DataWorks workspace.

0
ProjectRoleNamestring

The name of the role in the DataWorks workspace.

visitor
ProjectRoleCodestring

The code of the role in the DataWorks workspace.

role_project_guest

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "ProjectRoleList": [
    {
      "ProjectRoleId": 1,
      "ProjectRoleType": "0",
      "ProjectRoleName": "visitor",
      "ProjectRoleCode": "role_project_guest"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400Invalid.Tenant.ConnectionNotExistsThe connection does not exist.The connection does not exist.
400Invalid.Tenant.ProjectNotExistsThe project does not exist.The project does not exist.
400Invalid.Tenant.UserNotInProjectThe user is not in the project.The user is not in the project.
403Invalid.Tenant.UserIsNotProjectOwnerOrAdminThe user is not a project administrator or owner.The user is not a project administrator or owner.
403Invalid.Tenant.UserNotInTenantThe user is not in tenant.The user is not in tenant.

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

Change history

Change timeSummary of changesOperation
No change history