调用ListRoles API查询数据湖角色列表-数据湖构建-阿里云-数据湖构建(DLF)-阿里云帮助中心

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dlf:ListRoles

get

*全部资源

*

无

请求语法

GET /api/metastore/auth/roles/list HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
NextPageToken	string	否	翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（''）。	token!
RoleNamePattern	string	否	角色名称匹配的正则表达式。支持模糊搜索，比如.test.。	.test.
PageSize	integer	否	分页大小，最大值为 1000。	100

返回参数

名称	类型	描述	示例值
	object	返回消息体。
RequestId	string	请求 ID。	B7F4B621-E41E-4C84-B97F-42B5380A32BB
Code	string	状态码描述。	OK
Message	string	返回信息。	.
Success	boolean	是否调用成功。取值如下： true：调用成功。 false：调用失败。	True
NextPageToken	string	翻页令牌，用于获取下一页数据。	2cb472ec1bf84f8d92f9c4baa0d21c19aa
Roles	Roles	角色列表信息。	[ { "Description":"reserved by the system", "DisplayName":"admin", "UpdateTime":0, "IsPredefined":1, "Name":"admin" } ]

示例

正常返回示例

JSON格式

{
  "RequestId": "B7F4B621-E41E-4C84-B97F-42B5380A32BB",
  "Code": "OK",
  "Message": ".",
  "Success": true,
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "Roles": [
    {
      "Name": "role_name",
      "Description": "role description",
      "Users": [
        {
          "PrincipalArn": "acs:ram::[AliyunAccountId]:user/username_abc"
        }
      ],
      "DisplayName": "显示名称，允许中文",
      "PrincipalArn": "acs:dlf::111:role/role_name",
      "CreateTime": 1647323053,
      "UpdateTime": 1647323053,
      "IsPredefined": 1
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。