创建队列
功能介绍
该API用于创建队列,该队列将会绑定用户指定的计算资源。

新队列第一次运行作业时,需要一定的时间,通常为5~15分钟。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式:
- 参数说明
表1 URI参数 参数名称
是 否必选
参数类型
说明
project_id
是
String
参数解释:
项目编号,用于资源隔离。获取方式请参考获取项目ID。
示例: 48cc2c48765f481480c7db940d6409d1
约束限制:
无
取值范围:
只能由英文字母和数字组成,且长度为[1-64]个字符。
默认取值:
无
请求消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
queue_name |
是 |
String |
新建的队列名称, 参数解释: 新建的队列名称。 约束限制:
取值范围: 无 默认取值: 无 |
queue_type |
否 |
String |
参数解释: 队列的类型。 约束限制: 如果不指定类型,则默认为“sql”。 取值范围:
默认取值: 无 |
description |
否 |
String |
参数解释: 队列的描述信息。 约束限制: 无 取值范围: 无 默认取值: 无 |
cu_count |
是 |
Integer |
参数解释: 与队列绑定的最小计算单元个数。 约束限制: 无 取值范围: 设置值当前只支持16,64,256。 默认取值: 无 |
charging_mode |
否 |
Integer |
参数解释: 队列的收费模式。 约束限制: 无 取值范围: 只能设置为“1”,表示按照CU时收费。 默认取值: 无 |
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,“0”表示default,即默认的企业项目。 关于如何设置企业项目请参考《企业管理用户指南》。 约束限制: 仅开通了企业管理服务的用户可设置该参数绑定指定的项目。 取值范围: 无 默认取值: 无 |
platform |
否 |
String |
参数解释: 队列计算资源的cpu架构。 约束限制: 无 取值范围:
默认值为x86_64。 默认取值: 无 |
resource_mode |
否 |
Integer |
参数解释: 队列资源模式。 约束限制: 无 取值范围: 0:共享资源模式 1:专属资源模式 默认取值: 无 |
labels |
否 |
Array of Strings |
参数解释: 创建队列的标签信息,目前包括队列是否跨AZ的标签信息(Json字符串),且只支持值为“2”,即创建一个计算资源分布在2个可用区的双AZ队列。 约束限制: 无 取值范围: 无 默认取值: 无 |
feature |
否 |
String |
参数解释: 队列使用的镜像类型。 约束限制: 无 取值范围:
默认取值: 默认值为“basic”。 |
tags |
否 |
Array of Objects |
参数解释: 队列的标签,使用标签标识云资源。包括“标签键”和“标签值”,具体请参考表3。 约束限制: 无 取值范围: 无 默认取值: 无 |
elastic_resource_pool_name |
否 |
String |
参数解释: 新建队列所属的弹性资源池名称。 约束限制: 名称只能包含数字、小写英文字母和下划线,但不能是纯数字,且不能以下划线开头。 长度限制:1~128个字符。 添加队列到资源池,resource_mode必须为专属模式,否则不生效。 取值范围: 无 默认取值: 无 |
engine |
否 |
String |
参数解释: 队列的引擎类型。 约束限制: 只有在queue_type是sql条件下才可配置 取值范围: 可以选择spark引擎或hetuEngine。
了解引擎的详细类型和说明请参考DLI简介。 默认取值: 默认是spark。 |
properties |
否 |
object |
参数解释: 配置队列属性。请参考表4。 约束限制:
当前仅以下区域支持设置Spark Native属性:
取值范围: 请参考表4。 默认取值: 无 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
key |
是 |
String |
参数解释: 标签的键。 约束限制: 无 取值范围: 标签的键的最大长度为128个字符,标签的键可以包含任意语种字母、数字、空格和_ . : +-@ ,但首尾不能含有空格,不能以_sys_开头。 默认取值: 无 |
value |
是 |
String |
参数解释: 标签的值。 约束限制: 无 取值范围: 标签值的最大长度为255个字符,标签的值可以包含任意语种字母、数字、空格和_ . : +-@ 。 默认取值: 无 |
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
否 |
Boolean |
参数解释: 请求执行是否成功。“true”表示请求执行成功。 取值范围: 无 |
message |
否 |
String |
参数解释: 系统提示信息,执行成功时,信息可能为空。 取值范围: 无 |
queue_name |
否 |
String |
参数解释: 新增队列的名称。队列名称不区分大小写,系统会自动转换为小写。 取值范围: 无 |
请求示例
创建一个名称为queue1的通用类型的专属队列,该队列大小为16CU,且队列的计算资源分布在2个可用区。
{ "queue_name": "queue1", "description": "test", "cu_count": 16, "resource_mode": 1, "queue_type": "general", "labels": ["multi_az=2"] }
在指定的弹性资源池中创建队列
{ "queue_name": "queue2", "description": "test_esp", "cu_count": 16, "resource_mode": 1, "enterprise_project_id": "0", "queue_type": "general", "labels": ["multi_az=2"], "elastic_resource_pool_name": "elastic_pool_0622_10" }
响应示例
{ "is_success": true, "message": "", "queue_name": "queue1" }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。