文档首页 > > API参考> 队列相关API(推荐)>

查询队列详情

查询队列详情

分享
更新时间:2021/05/17 GMT+08:00

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

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

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    queue_name

    String

    指定查询的队列名称。

    说明:

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

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    queue_type

    String

    队列的类型,。有如下三种类型:

    • sql
    • general
    • all

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

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

queueName

String

队列名称。

说明:

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

description

String

队列描述信息。

owner

String

创建队列的用户。

create_time

Long

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

queueType

String

队列类型。

  • sql
  • general
  • all

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

cuCount

Integer

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

chargingMode

integer

队列的收费模式。

  • 1:表示按照CU时收费。
  • 2:表示按照包年包月收费。

resource_id

String

队列的资源ID。

resource_mode

Integer

资源模式。

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

enterprise_project_id

String

企业项目ID。

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

说明:

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

resource_type

String

资源类型。

  • vm:ecf集群
  • container:容器化集群(k8s)

示例

  • 请求样例
    None
  • 成功响应样例:
    {
        "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",
        "queue_resource_type": "vm"
    
    }

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

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

分享:

    相关文档

    相关产品