Querying Candidate Members

Function

This API is used to query candidate members of an application. Members in the abnormal state are filtered out.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Application ID.
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see "Appendix" > "Obtaining a Project ID" in the API Reference.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
filter	No	String	Filter criteria. If this parameter is not specified, all candidate members including the existing application members are returned. If this parameter is set to members, the existing application members are filtered out. This parameter is used when you want to add members in incremental mode.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
users	Array of CandidatesUser objects	Candidate members.

**Table 5** CandidatesUser
Parameter	Type	Description
name	String	Username.
id	String	User ID.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_details	String	Error information.
request_id	String	Request ID.

Example Requests

None

Example Responses

Status code: 200

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

Status code: 403

Forbidden

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