文档

ListUserBasicInfos - 查询所有RAM用户的基本信息

更新时间:

调用ListUserBasicInfos查询所有RAM用户的基本信息。

接口说明

您可以通过以下两个 API 查询所有 RAM 用户的信息,区别如下:

  • ListUsers:查询 RAM 用户的详细信息。
  • ListUserBasicInfos:查询 RAM 用户的基本信息,仅包括 RAM 用户登录名称UserPrincipalName、RAM 用户显示名称DisplayName和 RAM 用户 IDUserId

调试

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

授权信息

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

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

请求参数

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

当请求的返回结果被截断时,可以使用Marker获取从当前截断位置之后的内容。

EXAMPLE
MaxItemsinteger

返回结果的条数。当返回结果达到MaxItems限制被截断时,返回参数IsTruncated将等于true

取值范围:1~1000。默认值:100。

100
Tagarray<object>

标签列表。

object

标签列表。

Keystring

标签键。

N 的取值范围:1~20,N 必须连续。

operator
Valuestring

标签值。

N 的取值范围:1~20,N 必须连续。

alice
Statusstring

指定查询的用户状态,支持 active,freeze 状态。指定全部状态时使用逗号拼接,如:active,freeze。未指定状态时默认指定 active 状态。 使用 Tag 标签时,不支持指定 status 查询,默认查询全部状态的用户。

active

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F
IsTruncatedboolean

请求返回结果是否被截断。取值:

  • true:已截断。
  • false:未截断。
true
UserBasicInfosarray<object>

RAM 用户的基本信息。

object

RAM 用户的基本信息。

UserPrincipalNamestring

RAM 用户的登录名称。

test@example.onaliyun.com
DisplayNamestring

RAM 用户的显示名称。

test
UserIdstring

RAM 用户 ID。

20732900249392****
Statusstring

RAM 用户的用户状态。

active
Markerstring

IsTruncatedtrue时才有此参数,当返回true时,需要继续调用此接口,并且使用Marker获取截断后的内容。

EXAMPLE

示例

正常返回示例

JSON格式

{
  "RequestId": "EF2B25FD-CADE-445B-BE4D-E082E0FF1A0F",
  "IsTruncated": true,
  "UserBasicInfos": {
    "UserBasicInfo": [
      {
        "UserPrincipalName": "test@example.onaliyun.com",
        "DisplayName": "test",
        "UserId": "20732900249392****",
        "Status": "active"
      }
    ]
  },
  "Marker": "EXAMPLE"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-29OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-08-14OpenAPI 描述信息更新查看变更详情
2023-03-24OpenAPI 返回结构发生变更查看变更详情