查询队列详情
功能介绍
该API用于列出该project下指定的队列详情。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式：
- 参数说明
表1 URI参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号，用于资源隔离。获取方式请参考获取项目ID。
queue_name
是
String
指定查询的队列名称。
说明：队列名称不区分大小写，系统会自动转换为小写。
请求消息
无请求参数。
响应消息
|
参数名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
is_success |
否 |
Boolean |
请求执行是否成功。“true”表示请求执行成功。 |
|
message |
否 |
String |
系统提示信息，执行成功时，信息可能为空。 |
|
queue_id |
否 |
Long |
队列ID。 |
|
queueName |
否 |
String |
队列名称。
说明：
队列名称不区分大小写，系统会自动转换为小写。 |
|
description |
否 |
String |
队列描述信息。 |
|
owner |
否 |
String |
创建队列的用户。 |
|
create_time |
否 |
Long |
创建队列的时间。是单位为“毫秒”的时间戳。 |
|
queueType |
否 |
String |
队列类型。
如果不指定，默认为“sql”。 |
|
cuCount |
否 |
Integer |
与该队列绑定的计算单元数。即当前队列的CU数。 |
|
chargingMode |
否 |
integer |
队列的收费模式。
|
|
resource_id |
否 |
String |
队列的资源ID。 |
|
resource_mode |
否 |
Integer |
资源模式。
|
|
enterprise_project_id |
否 |
String |
企业项目ID。 "0”表示default，即默认的企业项目。
说明：
开通了企业管理服务的用户可设置该参数绑定指定的项目。 |
|
resource_type |
否 |
String |
资源类型。
|
|
cu_spec |
否 |
Integer |
队列的规格大小。对于包周期队列，表示包周期部分的CU值；对于按需队列，表示用户购买队列时的初始值。 |
|
cu_scale_out_limit |
否 |
Integer |
当前队列弹性扩缩容的CU值上限。 |
|
cu_scale_in_limit |
否 |
Integer |
当前队列弹性扩缩容的CU值下限。 |
|
elastic_resource_pool_name |
否 |
String |
弹性资源池名称。 |
请求示例
无
响应示例
{
"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
}
错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。
