文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 公共资源API/ 应用管理/ 查询候选用户成员
更新时间：2024-10-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询候选用户成员

功能介绍

查询应用的候选用户成员列表，会过滤掉异常状态用户。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/instances/{instance_id}/apps/{app_id}/candidates

表1 路径参数

参数

是否必选

参数类型

描述

app_id

是

String

应用ID。

instance_id

是

String

实例ID。

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。
表2 Query参数

参数

是否必选

参数类型

描述

filter

否

String

过滤条件。

  • 过滤条件，未提供时返回包括应用成员在内的所有候选用户列表。

  • 取值members时，过滤掉当前应用成员，适合增量添加应用成员时使用。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

users

Array of CandidatesUser objects

候选用户成员列表。
表5 CandidatesUser

参数

参数类型

描述

name

String

用户名称。

id

String

用户ID。

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

error_details

String

具体错误消息。

request_id

String

请求处理ID。

请求示例

无

响应示例

状态码： 200

OK

{
  "users" : [ {
    "name" : "chenjunjie",
    "id" : "06d9106f3b000f241f83c010d6b78c81"
  }, {
    "name" : "fdi-dm",
    "id" : "076d742f028025191fe9c0109200f5c8"
  } ]
}

状态码： 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

状态码

状态码

描述

200

OK

403

Forbidden

错误码

请参见错误码。

父主题： 应用管理

相关文档