更新时间:2022-12-07 GMT+08:00

查询队列详情

功能介绍

该API用于列出该project下指定的队列详情。

URI

  • URI格式:

    GET /v1.0/{project_id}/queues/{queue_name}

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    queue_name

    String

    指定查询的队列名称。

    说明:

    队列名称不区分大小写,系统会自动转换为小写。

请求消息

无请求参数。

响应消息

表2 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

请求执行是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

queueName

String

队列名称。

说明:

队列名称不区分大小写,系统会自动转换为小写。

description

String

队列描述信息。

owner

String

创建队列的用户。

create_time

Long

创建队列的时间。是单位为“毫秒”的时间戳。

queueType

String

队列类型。

  • sql
  • general
  • all

如果不指定,默认为“sql”

cuCount

Integer

与该队列绑定的计算单元数。即当前队列的CU数。

resource_id

String

队列的资源ID。

resource_mode

Integer

资源模式。

  • 0:共享队列
  • 1:专属队列

enterprise_project_id

String

企业项目ID。

"0”表示default,即默认的企业项目。

说明:

开通了企业管理服务的用户可设置该参数绑定指定的项目。

cu_spec

Integer

队列的规格大小。对于包周期队列,表示包周期部分的CU值;对于按需队列,表示用户购买队列时的初始值。

cu_scale_out_limit

Integer

当前队列弹性扩缩容的CU值上限。

cu_scale_in_limit

Integer

当前队列弹性扩缩容的CU值下限。

请求示例

响应示例

{
    "is_success": true,
    "message": "",
    "owner": "testuser",
    "description": "",
    "queueName": "test",
    "create_time": 1587613028851,
    "queueType": "general",
    "cuCount": 16,
    "resource_id": "03d51b88-db63-4611-b779-9a72ba0cf58b",
    "resource_mode": 0
,
    "resource_type": "vm",
     "cu_spec": 16
}

状态码

状态码如表3所示。

表3 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码