Viewing Details of a Queue
Function
This API is used to list details of a specific queue in a project.
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
Specifies the name of a queue to be queried.
NOTE:The queue name is case-insensitive. The uppercase letters will be automatically converted to lowercase letters.
Request Parameters
None
Response Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
is_success |
No |
Boolean |
Indicates 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. |
queueName |
No |
String |
Name of a queue.
NOTE:
The queue name is case-insensitive. The uppercase letters will be automatically converted to lowercase letters. |
description |
No |
String |
Queue description. |
owner |
No |
String |
User who creates a queue. |
create_time |
No |
Long |
Time when the queue is created. The timestamp is expressed in milliseconds. |
queueType |
No |
String |
Indicates the queue type.
If this parameter is not specified, the default value sql is used. |
cuCount |
No |
Integer |
Number of compute units (CUs) bound to a queue, that is, the number of CUs in the current queue. |
chargingMode |
No |
integer |
Billing mode of a queue.
|
resource_id |
No |
String |
Resource ID of a queue. |
resource_mode |
No |
Integer |
Resource mode
|
enterprise_project_id |
No |
String |
Enterprise project ID. 0 indicates the default enterprise project.
NOTE:
Users who have enabled Enterprise Management can set this parameter to bind a specified project. |
resource_type |
No |
String |
Resource type.
|
cu_spec |
No |
Integer |
Specifications of a queue. For a yearly/monthly queue, this parameter indicates the CU value of the yearly/monthly part. For a pay-per-use queue, this parameter indicates the initial value when a user purchases a queue. |
cu_scale_out_limit |
No |
Integer |
Upper limit of the CU value for elastic scaling of the current queue. |
cu_scale_in_limit |
No |
Integer |
Lower limit of the CU value for elastic scaling of the current queue. |
elastic_resource_pool_name |
No |
String |
Name of the elastic resource pool. |
Example Request
None
Example Response
{ "is_success": true, "message": "", "owner": "testuser", "description": "", "queueName": "test", "create_time": 1587613028851, "queueType": "general", "cuCount": 16, "chargingMode": 1, "resource_id": "03d51b88-db63-4611-b779-9a72ba0cf58b", "resource_mode": 0, "enterprise_project_id": "0", "resource_type": "vm", "cu_spec": 16 }
Status Codes
Table 3 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 Codes.
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