新增队列属性_队列相关API（推荐）_API参考

功能介绍

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

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

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

授权信息

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

约束与限制

仅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,
      "maxPrefetchInstance": 1
    },
    "job": {
      "maxConcurrent": 32
    }
  }
}

响应示例

无

状态码

状态码如表5所示。

表5 状态码
状态码	描述
200	新增属性接口调用成功。
400	请求失败。
500	内部服务器错误。

错误码

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

新增队列属性