更新时间:2024-07-18 GMT+08:00

创建队列

功能介绍

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

新队列第一次运行作业时,需要一定的时间,通常为5~15分钟。

URI

  • URI格式:

    POST /v1.0/{project_id}/queues

  • 参数说明
    表1 URI参数

    参数名称

    是 否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

queue_name

String

新建的队列名称,名称只能包含数字、英文字母和下划线,但不能是纯数字,且不能以下划线开头。长度限制:1~128个字符。

说明:

队列名称不区分大小写,系统会自动转换为小写。

queue_type

String

队列的类型,。有如下类型:

  • sql:SQL队列类型,用于运行SQL作业。
  • general:通用队列类型,用于运行Flink、Spark Jar作业。
说明:

如果不指定类型,则默认为“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:基础型
  • ai:AI增强型(仅SQL的x86_64专属队列支持选择)

默认值为“basic”

说明:

AI增强型即队列加载了AI镜像,该镜像在基础镜像的基础上集成了AI相关的算法包。

tags

Array of Objects

队列的标签,使用标签标识云资源。包括“标签键”和“标签值”,具体请参考表3

elastic_resource_pool_name

String

新建队列所属的弹性资源池名称。

名称只能包含数字、小写英文字母和下划线,但不能是纯数字,且不能以下划线开头。

长度限制:1~128个字符。

说明:

添加队列到资源池,resource_mode必须为专属模式,否则不生效。

表3 tags参数

参数名称

是否必选

参数类型

说明

key

String

标签的键。
说明:

标签的键的最大长度为128个字符,标签的键可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格,不能以_sys_开头。

value

String

标签的值。
说明:

标签值的最大长度为255个字符,标签的值可以包含任意语种字母、数字、空格和_ . : =+-@ ,但首尾不能含有空格。

响应消息

表4 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

queue_name

String

新增队列的名称。

说明:

队列名称不区分大小写,系统会自动转换为小写。

请求示例

创建一个名称为queue1的通用类型的专属队列,该队列大小为16CU,且队列的计算资源分布在2个可用区。

{
    "queue_name": "queue1",
    "description": "test",
    "cu_count": 16,
    "resource_mode": 1,
    "enterprise_project_id": "0",
    "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"
}

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

创建成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码