创建队列
功能介绍
该API用于创建队列,该队列将会绑定用户指定的计算资源。
新队列第一次运行作业时,需要一定的时间,通常为5~15分钟。
调试
您可以在API Explorer中调试该接口。
URI
- URI格式:
- 参数说明
表1 URI参数 参数名称
是 否必选
参数类型
说明
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
请求消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
queue_name |
是 |
String |
新建的队列名称,名称只能包含数字、英文字母和下划线,但不能是纯数字,且不能以下划线开头。长度限制:1~128个字符。
说明:
队列名称不区分大小写,系统会自动转换为小写。 |
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。
说明:
aarch64架构计算资源使用华为鲲鹏系列服务器。 |
resource_mode |
否 |
Integer |
队列资源模式。支持以下两种类型: 0:共享资源模式 1:专属资源模式 |
labels |
否 |
Array of Strings |
创建队列的标签信息,目前包括队列是否跨AZ的标签信息(Json字符串),且只支持值为“2”,即创建一个计算资源分布在2个可用区的双AZ队列。 |
feature |
否 |
String |
队列使用的镜像类型。支持以下两种类型:
默认值为“basic”。
说明:
AI增强型即队列加载了AI镜像,该镜像在基础镜像的基础上集成了AI相关的算法包。 |
tags |
否 |
Array of Objects |
队列的标签,使用标签标识云资源。包括“标签键”和“标签值”,具体请参考表3。 |
elastic_resource_pool_name |
否 |
String |
新建队列所属的弹性资源池名称。 名称只能包含数字、小写英文字母和下划线,但不能是纯数字,且不能以下划线开头。 长度限制:1~128个字符。
说明:
添加队列到资源池,resource_mode必须为专属模式,否则不生效。 |
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
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" }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。