ListUsers - 查询所有RAM用户的详细信息

查询所有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:ListUserslist
*User
acs:ram::{#accountId}:user/*

请求参数

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

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

EXAMPLE
MaxItemsinteger

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

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

1000
Tagarray<object>

标签列表,最多包含 20 个子项。

object

标签列表,最多包含 20 个子项。

Keystring

标签键。

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

operator
Valuestring

标签值。

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

alice
Statusstring

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

active

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

4B450CA1-36E8-4AA2-8461-86B42BF4CC4E
IsTruncatedboolean

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

  • true
  • false
true
Markerstring

此参数在IsTruncatedtrue时生效,用于获取截断后的内容。

EXAMPLE
Usersarray<object>

RAM 用户信息。

Userobject

RAM 用户信息。

DisplayNamestring

RAM 用户的显示名称。

test
UserPrincipalNamestring

RAM 用户的登录名称。

test@example.onaliyun.com
Emailstring

RAM 用户的电子邮箱。

说明 该参数仅适用于中国站。
alice@example.com
UpdateDatestring

RAM 用户的更新时间(UTC 时间)。

2023-08-21T06:12:47Z
MobilePhonestring

RAM 用户的手机号码。

说明 该参数仅适用于中国站。
86-1868888****
UserIdstring

RAM 用户 ID。

20732900249392****
Commentsstring

备注。

This is a cloud computing engineer.
LastLoginDatestring

RAM 用户最近一次登录控制台的时间(时间戳)。

1692598367586
CreateDatestring

RAM 用户的创建时间(UTC 时间)。

2020-08-25T09:23:57Z
ProvisionTypestring

同步类型。取值:

  • Manual:在 RAM 中手动创建的 RAM 用户。
  • SCIM:通过 SCIM 协议同步创建的 RAM 用户。
  • CloudSSO:通过云 SSO 同步创建的用户。
Manual
Statusstring

RAM 用户的用户状态。

active
Tagsarray<object>

标签列表。

Tagobject

标签列表。

TagKeystring

标签键。

oparator
TagValuestring

标签值。

alice

示例

正常返回示例

JSON格式

{
  "RequestId": "4B450CA1-36E8-4AA2-8461-86B42BF4CC4E",
  "IsTruncated": true,
  "Marker": "EXAMPLE",
  "Users": {
    "User": [
      {
        "DisplayName": "test",
        "UserPrincipalName": "test@example.onaliyun.com",
        "Email": "alice@example.com",
        "UpdateDate": "2023-08-21T06:12:47Z",
        "MobilePhone": "86-1868888****",
        "UserId": "20732900249392****",
        "Comments": "This is a cloud computing engineer.",
        "LastLoginDate": "1692598367586",
        "CreateDate": "2020-08-25T09:23:57Z",
        "ProvisionType": "Manual",
        "Status": "active",
        "Tags": {
          "Tag": [
            {
              "TagKey": "oparator",
              "TagValue": "alice"
            }
          ]
        }
      }
    ]
  }
}

错误码

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

变更历史

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