更新时间:2025-11-21 GMT+08:00
分享

查询用户详情 - ShowUser

功能介绍

查询用户详情。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/instances/{instance_id}/users/{user_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

user_name

String

用户名。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

access_key

String

参数解释

用户名。

取值范围

不涉及。

secret_key

String

参数解释

密钥。

取值范围

不涉及。

white_remote_address

String

参数解释

IP白名单。

取值范围

不涉及。

admin

Boolean

参数解释

是否为管理员。

取值范围

  • true:是管理员。

  • false:不是管理员。

default_topic_perm

String

参数解释

默认的主题权限。

取值范围

  • PUB:拥有发布权限。

  • SUB:拥有订阅权限。

  • PUB|SUB:拥有发布订阅权限。

  • DENY:无权限。

default_group_perm

String

参数解释

默认的消费组权限。

取值范围

  • SUB:拥有订阅权限。

  • DENY:无权限。

topic_perms

Array of topic_perms objects

参数解释

特殊的主题权限。

group_perms

Array of group_perms objects

参数解释

特殊的消费组权限。

表3 topic_perms

参数

参数类型

描述

name

String

参数解释

主题名称。

取值范围

不涉及。

perm

String

参数解释

Topic权限。

取值范围

  • PUB:拥有发布权限。

  • SUB:拥有订阅权限。

  • PUB|SUB:拥有发布订阅权限。

  • DENY:无权限。

表4 group_perms

参数

参数类型

描述

name

String

参数解释

消费组名称。

取值范围

不涉及。

perm

String

参数解释

消费组权限。

取值范围

  • SUB:拥有订阅权限。

  • DENY:无权限。

请求示例

查询用户详情。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/users/{user_name}

响应示例

状态码:200

查询用户详情成功。

{
  "access_key" : "test_01",
  "admin" : false,
  "default_group_perm" : "DENY",
  "default_topic_perm" : "SUB",
  "group_perms" : [ ],
  "secret_key" : "Abcd1234!",
  "topic_perms" : [ ],
  "white_remote_address" : ""
}

状态码

状态码

描述

200

查询用户详情成功。

错误码

请参见错误码

相关文档