全部产品
Search

搜索本产品

    运维安全中心（堡垒机）：GetUser - 获取用户信息

    文档中心

    运维安全中心（堡垒机）：GetUser - 获取用户信息

    更新时间：Jan 21, 2026

    获取指定堡垒机用户的详细信息。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    yundun-bastionhost:GetUser

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InstanceId

    string

    是

    指定要查询的用户所在堡垒机的实例 ID。

    说明

    您可以调用 DescribeInstances 接口获取该参数。

    bastionhost-cn-st220aw****
    RegionId

    string

    否

    指定要查询的用户所在堡垒机的区域 ID。

    说明

    区域 ID 和区域名称的对应关系，请参见地域和可用区。

    cn-hangzhou
    UserId

    string

    是

    指定要查询的用户 ID。

    说明

    您可以调用 ListUsers 接口获取该参数。

    1

    调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。 调用 API 的请求格式，请参见本文示例中的请求示例。

    返回参数

    名称

    类型

    描述

    示例值

    object

    响应数据。

    RequestId

    string

    阿里云为该请求生成的唯一标识符。

    EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    User

    object

    查询到的用户详细信息。

    DisplayName

    string

    用户的显示姓名。

    Bob
    Comment

    string

    用户备注信息。

    commet
    Email

    string

    用户的邮箱地址。

    1099**@qq.com
    Mobile

    string

    用户的手机号码。

    1359999****
    MobileCountryCode

    string

    用户手机号码的国际域名。取值：

    • CN：中国内地（+86）

    • HK：中国香港（+852）

    • MO：中国澳门（+853）

    • TW：中国台湾（+886）

    • RU：俄罗斯（+7）

    • SG：新加坡（+65）

    • MY：马来西亚（+60）

    • ID：印度尼西亚（+62）

    • DE：德国（+49）

    • AU：澳大利亚（+61）

    • US：美国（+1）

    • AE：迪拜（+971）

    • JP：日本（+81）

    • GB：英国（+44）

    • IN：印度（+91）

    • KR：韩国（+82）

    • PH：菲律宾（+63）

    • CH：瑞士（+41）

    • SE：瑞典（+46）

    CN
    UserId

    string

    用户 ID。

    1
    Source

    string

    用户的来源。取值：

    • Local：本地用户

    • Ram：RAM 用户

    Local
    UserName

    string

    用户的登录名称。

    abcabc_def
    SourceUserId

    string

    用户的唯一标识。

    说明

    该参数是堡垒机用户对应的 RAM 用户的唯一标识。用户来源为 RAM 用户（即 Source 取值为 Ram）时，返回该参数。用户来源为本地用户（即 Source 取值为 Local）时，该参数返回值为空。

    122748924538****
    UserState

    array

    用户状态组。

    string

    用户的状态。取值：

    • Normal：正常状态

    • Frozen：被锁定状态

    • Expired：已过期状态

    ["Normal"]
    EffectiveStartTime

    integer

    用户有效期开始时间（秒，时间戳格式）

    1669630029
    EffectiveEndTime

    integer

    用户有效期结束时间（秒，时间戳格式）

    1672502400
    NeedResetPassword

    boolean

    下次登录是否需要重置密码。取值：

    • true：是

    • false：否

    true
    TwoFactorMethods

    array

    打开的双因子认证方式的数组

    string

    打开双因子认证方式的数组，目前最多支持一个，取值：

    • sms：短信

    • email：邮件

    • dingtalk：钉钉

    • totp OTP：令牌

    [ "sms" ]
    TwoFactorStatus

    string

    用户双因子状态，取值：

    • Global：遵循全局设定

    • Disable：关闭双因子

    • Enable：开启双因子，遵循单个用户设定

    Enable
    LanguageStatus

    string

    消息通知语言设置。

    • Global：遵循全局

    • Custom：自定义

    Custom
    Language

    string

    当 LanguageStatus 为 Custom 时，Language 为必填。 取值：

    • zh-cn：简体中文

    • en：英文

    en

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "User": {
    "DisplayName": "Bob",
    "Comment": "commet",
    "Email": "1099**@qq.com",
    "Mobile": "1359999****",
    "MobileCountryCode": "CN",
    "UserId": "1",
    "Source": "Local",
    "UserName": "abcabc_def",
    "SourceUserId": "122748924538****",
    "UserState": [
      "[\"Normal\"]"
    ],
    "EffectiveStartTime": 1669630029,
    "EffectiveEndTime": 1672502400,
    "NeedResetPassword": true,
    "TwoFactorMethods": [
      "[\n      \"sms\"\n]"
    ],
    "TwoFactorStatus": "Enable",
    "LanguageStatus": "Custom",
    "Language": "en"
  }
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    400 InvalidParameter The argument is invalid. 参数错误
    500 InternalError An unknown error occurred. 未知错误
    404 UserNotFound The user is not found. 用户不存在

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

    变更历史

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