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

获取队列属性

功能介绍

该API用于获取队列配置的属性。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限及授权项说明。

URI

  • URI格式：

    GET /v3/{project_id}/queues/{queue_name}/properties

  • 参数说明
    表1 路径参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

    queue_name

    是

    String

    待修改定时扩缩计划的队列名称。名称长度为1~128个字符，多个队列名称使用逗号“,”分隔。

    表2 Query参数

    参数

    是否必选

    参数类型

    描述

    offset

    否

    Integer

    查询结果偏移量，默认为0。

    limit

    否

    Integer

    每页显示条数，默认为1000。

请求消息

无

响应消息

状态码： 200

表3 响应Body参数

参数

参数类型

描述

is_success

Boolean

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

message

String

消息内容。

properties

Array of properties objects

请参考表4。

表4 properties

参数

参数类型

描述

key

String

返回属性值对应的key值 。

  • computeEngine.maxInstances：队列能启动的最大spark driver数量。
  • computeEngine.maxPrefetchInstance：队列预先启动的最大spark driver数量。
  • job.maxConcurrent：单个spark driver能同时运行的最大任务数量。
  • multipleSc.support：是否支持设置多个spark driver。
  • job.saveJobResultToJobBucket：是否使用用户作业桶保存SQL查询结果，true代表已开启。
  • computeEngine.spark.nativeEnabled 是否使用DLI Spark Native；

枚举值：

  • computeEngine.maxInstances
  • computeEngine.maxPrefetchInstance
  • job.maxConcurrent
  • multipleSc.support
  • job.saveJobResultToJobBucket
  • computeEngine.spark.nativeEnabled

value

String

返回属性值对应的value值。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述信息。

请求示例

无

响应示例

{
 "message": "ok",
 "is_success": true,
 "properties": [
    "computeEngine.maxInstance" : 2,
    "job.maxConcurrent" : 32,
    "computeEngine.maxPrefetchInstance" : 1
]
}

状态码

状态码如表6所示。

表6 状态码

状态码

描述

200

队列属性列表结果查询成功。

400

请求失败。

500

内部服务器错误。

错误码

调用接口出错后，将返回错误码和错误信息，更多介绍请参见错误码。