ListRoles - 获取角色列表

获取角色列表。

调试

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

授权信息

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

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

请求语法

GET /dlf/v1/auth/roles/list HTTP/1.1

请求参数

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

角色名称。

role_name
pageTokenstring

翻页令牌,用于获取下一页数据。如果响应结果中没有提供,则传空字符串("")或空字符('')。

""
maxResultsinteger

每页大小。

10

返回参数

名称类型描述示例值
object

返回消息体。

rolesarray

角色信息列表。

rolesRole

角色信息。

nextPageTokenstring

翻页令牌,用于获取下一页数据。当返回 null 时,表示当前查询的是最后一页结果。

E8ABEB1C3DB893D16576269017992F57

示例

正常返回示例

JSON格式

{
  "roles": [
    {
      "createdAt": 1744970111419,
      "isPredefined": true,
      "updatedBy": "acs:ram::[accountId]:root",
      "createdBy": "acs:ram::[accountId]:root",
      "displayName": "role_display_name",
      "roleName": "role_name",
      "description": "role_description",
      "rolePrincipal": "acs:dlf::[accountId]:role/role_name",
      "users": [
        {
          "createdAt": 1744970111419,
          "updatedBy": "acs:ram::[accountId]:root",
          "createdBy": "acs:ram::[accountId]:root",
          "displayName": "user_display_name",
          "userName": "user_name",
          "type": "RAM_USER",
          "userId": "222748924538****",
          "userPrincipal": "acs:ram::[accountId]:user/user_name",
          "updatedAt": 1744970111419
        }
      ],
      "updatedAt": 1744970111419
    }
  ],
  "nextPageToken": "E8ABEB1C3DB893D16576269017992F57"
}

错误码

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