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

更新队列属性

功能介绍

该API用于更新队列属性。

调试

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

URI

  • URI格式:

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

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    queue_name

    String

    待修改属性的队列名称。

    名称长度为1~128个字符,多个队列名称使用逗号“,”分隔。

请求消息

表2 请求Body参数

参数

是否必选

参数类型

描述

properties

object

待更新属性。请参考properties

表3 properties

参数

是否必选

参数类型

描述

computeEngine.maxInstance

Integer

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

job.maxConcurrent

Integer

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

computeEngine.maxPrefetchInstance

Integer

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

network.cidrInVpc

String

设置队列网段。

job.saveJobResultToJobBucket

String

是否使用作业桶保存SQL查询结果

computeEngine.spark.nativeEnabled

String

是否开启Spark Native。

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

响应消息

状态码: 200

表4 响应Body参数

参数

参数类型

描述

is_success

Boolean

是否更新成功。

message

String

接口相关说明。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述信息。

请求示例

更新队列的属性。

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

响应示例

状态码

状态码如表6所示。

表6 状态码

状态码

描述

200

返回结果,is_success=true代表更新成功。

400

请求失败。

500

内部服务器错误。

错误码

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

相关文档