文档首页 > > API参考> 队列相关API(推荐)>

创建队列

创建队列

分享
更新时间:2021/03/23 GMT+08:00

功能介绍

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

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

调试

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

URI

  • URI格式:

    POST /v1.0/{project_id}/queues

  • 参数说明
    表1 URI参数

    参数名称

    是 否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

queue_name

String

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

说明:

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

queue_type

String

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

  • sql
  • general
  • all
说明:

如果不指定类型,则默认为“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
  • aarch64

默认值为x86_64。

说明:

aarch64架构计算资源使用华为鲲鹏系列服务器。

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相关的算法包,详细说明请参考《数据湖探索用户指南》。

tag

Array of Strings

队列的标签。具体请参考表3

表3 tag参数

参数名称

是否必选

参数类型

说明

key

String

标签的键。

value

String

标签的值。

响应消息

表4 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

queue_name

String

新增队列的名称。

说明:

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

示例

  • 请求样例:
    {
        "queue_name": "queue1",
        "description": "test",
        "cu_count": 16,
        "resource_mode": 1,
        "queue_type": "general",
        "labels": ["multi_az=2"]
    }
  • 成功响应样例:
    {
      "is_success": true,
      "message": "",
      "queue_name": "queue1"
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

创建成功。

400

请求错误。

500

内部服务器错误。

错误码

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

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区论坛频道来与我们联系探讨

智能客服提问云社区提问