更新时间:2025-06-24 GMT+08:00
分享

新增队列属性

功能介绍

该接口用于增加队列属性。支持一次新增多个属性。

当前支持设置的队列的属性:

Spark driver的相关参数:通过设置队列的Spark driver,以提升队列资源的调度效率。

调试

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

约束与限制

  • 仅Spark引擎的SQL队列支持配置队列属性。
  • 仅在队列创建完成后支持设置队列属性。
  • 当前仅支持设置Spark driver相关队列属性。
  • 不支持批量设置队列属性。

URI

  • URI格式:

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

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    queue_name

    String

    队列名称。

请求消息

表2 body参数

参数名称

是否必选

参数类型

说明

properties

object

待更新队列属性。请参考表3

表3 properties参数说明

参数名称

是否必选

参数类型

说明

computeEngine.maxInstance

integer

队列能启动的最大spark driver数量。

job.maxConcurrent

integer

单个spark driver能同时运行的最大任务数量。

computeEngine.maxPrefetchInstance

integer

队列预先启动的最大spark driver数量。

computeEngine.spark.nativeEnabled

String

是否开启Spark Native。

当前仅以下区域支持设置Spark Native属性:
  • 华北-乌兰察布一
  • 西南-贵阳一
  • 亚太-曼谷
  • 亚太-新加坡

响应消息

表4 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

请求示例

设置队列的属性。

{
  "properties" : {
    "computeEngine.maxInstance" : 2,
    "job.maxConcurrent" : 32,
    "computeEngine.maxPrefetchInstance" : 1
  }
}

响应示例

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

新增属性接口调用成功。

400

请求失败。

500

内部服务器错误。

错误码

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

相关文档