Querying the List of Users Bound to a Resource Pool

Function

This API is used to query the list of users bound to a resource pool.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/workload/queues/{queue_name}/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A
queue_name	Yes	String	Definition Resource pool name. Constraints N/A Range N/A Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Size of a single page. Constraints N/A Range Greater than 0 Default Value 10
offset	No	Integer	Definition Page offset, which starts from 0 (page number minus 1). Constraints N/A Range Greater than or equal to 0 Default Value 0

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
workload_res_code	Integer	Definition Result status code. Range N/A
workload_res_str	String	Definition Result description. Range N/A
queue_name	String	Definition Queue name. Range N/A
user_list	Array of WorkloadQueueUser objects	Definition List of queue users. Range N/A
count	Integer	Definition Total number. Range N/A

**Table 4** WorkloadQueueUser
Parameter	Type	Description
user_name	String	Definition Username. Range N/A
occupy_resource_list	Array of OccupyResource objects	Definition Plan execution stage. Range N/A
exec_result	Integer	Definition Execution result. Range N/A
exec_log	String	Definition Execution log. Range N/A

**Table 5** OccupyResource
Parameter	Type	Description
resource_name	String	Definition Resource item name. Range N/A
resource_value	Integer	Definition Resource attribute value. Range N/A
value_unit	String	Definition Resource attribute unit. Range N/A
resource_description	String	Definition Additional resource description. Range N/A

Example Requests

GET https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/e59d6b86-9072-46eb-a996-13f8b44994c1/workload/queues/resource1/users

Example Responses

Status code: 200

List of users bound to the resource pool queried.

{
  "queue_name" : "rs1",
  "user_list" : [ {
    "user_name" : "user_batch",
    "occupy_resource_list" : [ {
      "resource_name" : "memory_used",
      "resource_value" : 0,
      "value_unit" : "M",
      "resource_description" : ""
    } ]
  } ],
  "count" : 1
}

Status Codes

Status Code	Description
200	List of users bound to the resource pool queried.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.