文档首页/数据湖探索 DLI/API参考/队列相关API（推荐）/查询队列详情
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询队列详情

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    Action

    访问级别

    Access Level

    资源类型（*为必须）

    Resource Type (*: required)

    条件键

    Condition Key

    别名

    Alias

    依赖的授权项

    Dependencies

    dli:queue:get

    Read

    queue *

    -

    -

    -

    -

    -

    -

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：SQL队列类型，用于运行SQL作业。
  • general：通用队列类型，用于运行Flink、Spark Jar作业。

如果不指定，默认为“sql”。

cuCount

否

Integer

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

chargingMode

否

integer

队列的收费模式。

  • 0：系统默认default队列。按照扫描量计费。
  • 1：表示按照CU时收费。

resource_id

否

String

队列的资源ID。

resource_mode

否

Integer

资源模式。

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

enterprise_project_id

否

String

企业项目ID。

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

说明：

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

resource_type

否

String

资源类型。

  • vm：ecf集群
  • container：容器化集群（k8s）

cu_spec

否

Integer

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

cu_scale_out_limit

否

Integer

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

cu_scale_in_limit

否

Integer

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

elastic_resource_pool_name

否

String

弹性资源池名称。

support_spark_versions

否

Array[String]

队列支持的Spark版本。

default_spark_version

否

String

队列默认的Spark版本。

support_hetu_engine_versions

否

Array[String]

队列支持的HetuEngine版本。

default_hetu_engine_version

否

String

队列默认的HetuEngine版本。

support_flink_sql_versions

否

Array[String]

队列支持的Flink SQL版本。

default_flink_sql_version

否

String

队列默认的Flink SQL版本。

support_flink_jar_versions

否

Array[String]

队列支持的Flink JAR版本。

default_flink_jar_version

否

String

队列默认的Flink JAR版本。

请求示例

无

响应示例

{
    "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
}

状态码

状态码如表3所示。

表3 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

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