Querying Queue Users
Function
This API is used to query names of all users who can use a specified queue.
URI
- URI format
- Parameter description
Table 1 URI parameters Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.
queue_name
Yes
String
Name of a queue.
Table 2 query parameter description Parameter
Mandatory
Type
Description
limit
Yes
Integer
Number of records to be displayed of the page-based query.
offset
Yes
Integer
Specifies the offset of the page-based query.
Request
None
Response
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
is_success |
No |
Boolean |
Whether the request is successfully executed. Value true indicates that the request is successfully executed. |
message |
No |
String |
System prompt. If execution succeeds, the parameter setting may be left blank. |
queue_name |
No |
String |
Name of a queue. |
privileges |
No |
Array of Object |
Users who are granted with the permission to use this queue and the permission array to which users belong. For details, see Table 4. |
Example Request
None
Example Response
{ "is_success": true, "message": "", "privileges": [ { "is_admin": true, "privileges": [ "ALL" ], "user_name": "tenant1" }, { "is_admin": false, "privileges": [ "SUBMIT_JOB" ], "user_name": "user2" } ], "queue_name": "queue1" }
Status Codes
Table 5 describes the status code.
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot