GetWorkspaceRole - Platform For AI - Alibaba Cloud Documentation Center

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/v1/workspaces/{WorkspaceId}/roles/{RoleId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID. You can obtain this ID by calling the ListWorkspaces operation.	image-tzi7f9czc0cxs9s45t
RoleId	string	No	The custom role ID.	role-sw******2tij

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A519F77D-28A0-52F5-AB82-5********8
RoleName	string	The role name.	dev-test
RoleId	string	The role ID.	role-dhg*******
GmtCreateTime	string	The time when the role was created. It is specified in UTC and formatted in ISO 8601.	2025-06-11T08:58:35.438Z
GmtModifiedTime	string	The time when the role was last modified. It is specified in UTC and formatted in ISO 8601.	2026-03-27T02:26:33.872Z
Creator	string	The Alibaba Cloud account UID of the creator.	2680******4103
ModulePermissions	ModulePermissions	The permission configuration of the role.
Status	string	The task status. Valid values: `Creating`: The role is being created. `Updating`: The role is being updated. `Deleting`: The role is being deleted. `Succeeded`: The task succeeded. `Failed`: The task failed.	Successful

Examples

Success response

JSON format

{
  "RequestId": "A519F77D-28A0-52F5-AB82-5********8",
  "RoleName": "dev-test",
  "RoleId": "role-dhg*******\n",
  "GmtCreateTime": "2025-06-11T08:58:35.438Z",
  "GmtModifiedTime": "2026-03-27T02:26:33.872Z",
  "Creator": "2680******4103",
  "ModulePermissions": [
    {
      "ModuleName": "PaiDesigner",
      "PermissionType": "ReadOnly",
      "Permissions": [
        {
          "PermissionCodes": [
            "PaiDLC:GetTensorboard"
          ],
          "PermissionRules": [
            {
              "Accessibility": "PRIVATE",
              "EntityAccessType": "CREATOR"
            }
          ]
        }
      ]
    }
  ],
  "Status": "Successful"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.