ListProjectRoles - 获取工作空间角色详情列表

分页查询工作空间角色详情。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:ListProjectRoleslist
*全部资源
*

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间管理页面获取 ID。

该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。

21229
Codesarray

工作空间角色 Code 列表

string

工作空间的角色 Code。

  • role_project_admin:空间管理员
  • role_project_dev:开发
  • role_project_dg_admin:数据治理管理员
  • role_project_guest:访客
  • role_project_security:安全管理员
  • role_project_deploy:部署
  • role_project_owner:工作空间所有者
  • role_project_data_analyst:数据分析师
  • role_project_pe:运维
  • role_project_erd:模型设计师
role_project_guest
Namesarray

工作空间的角色 Name 列表

string

工作空间的角色 Name。

Visitors
Typestring

工作空间的角色类型。

  • UserCustom:用户自定义角色
  • System:系统角色
System
PageNumberinteger

请求的数据页数,用于翻页。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。用于定位日志,排查问题。

61649187-0BCF-5E75-8D4B-64FDBEBBB447
PagingInfoobject

分页信息

PageSizestring

每页显示的条数

10
PageNumberstring

请求的数据页数,用于翻页。

1
TotalCountstring

满足条件的数据总条数。

42
ProjectRolesarray<object>

工作空间角色列表

ProjectRoleobject

工作空间角色详细信息

ProjectIdlong

DataWorks 工作空间的 ID。

特殊说明:系统默认的工作空间角色,ProjectId 返回固定值-1。

21229
Codestring

工作空间的角色 Code。

role_project_guest
Namestring

工作空间的角色 Name。

Visitors
Typestring

工作空间的角色类型。

System

示例

正常返回示例

JSON格式

{
  "RequestId": "61649187-0BCF-5E75-8D4B-64FDBEBBB447",
  "PagingInfo": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 42,
    "ProjectRoles": [
      {
        "ProjectId": 21229,
        "Code": "role_project_guest\n",
        "Name": "Visitors",
        "Type": "System"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史