ListProjectRoles - 获取工作空间角色详情列表 - 大数据开发治理平台 DataWorks

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间管理页面获取 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	21229
Codes	array	否	工作空间角色 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
Names	array	否	工作空间的角色 Name 列表
	string	否	工作空间的角色 Name。	访客
Type	string	否	工作空间的角色类型。枚举值： UserCustom：用户自定义角色。 System：系统角色。	System
PageNumber	integer	否	请求的数据页数，用于翻页。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大 100 条。	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。用于定位日志，排查问题。	61649187-0BCF-5E75-8D4B-64FDBEBBB447
PagingInfo	object	分页信息
PageSize	string	每页显示的条数	10
PageNumber	string	请求的数据页数，用于翻页。	1
TotalCount	string	满足条件的数据总条数。	42
ProjectRoles	array<object>	工作空间角色列表
ProjectRole	object	工作空间角色详细信息
ProjectId	long	DataWorks 工作空间的 ID。	21229
Code	string	工作空间的角色 Code。	role_project_guest
Name	string	工作空间的角色 Name。	访客
Type	string	工作空间的角色类型。	System

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史