# 查询所有队列 - ListQueues #### 功能介绍 该API用于列出该project下所有的队列。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DLI&api=ListQueues)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key | 别名 Alias | 依赖的授权项 Dependencies | |:---|:---|:---|:---|:---|:---| | dli:queue:list | List | queue \* | - | - | - | | dli:queue:list | List | - | - [g:RequestTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) - [g:TagKeys](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html) | - | - | #### URI - URI格式： GET /v1.0/{project_id}/queues - 参数说明 表1URI参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 | 表2query参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | queue_type | 否 | String | 队列的类型，有如下三种类型： - sql：查询SQL队列类型的队列。 - general：查询通用队列类型的队列。 - all：查询所有类型的队列。 如果不指定，默认为sql。 | | with-priv | 否 | Boolean | 是否返回权限信息。 | | with-charge-info | 否 | Boolean | 是否返回收费信息。 | | page-size | 否 | Integer | 每页显示的最大结果行数，默认值Integer.MAX_VALUE（也即不分页）。 | | current-page | 否 | Integer | 当前页码，默认为第一页。 | | order | 否 | String | 指定队列排序方式。 默认为queue_name_asc（队列名称升序），支持queue_name_asc（队列名称升序）、queue_name_desc（队列名称降序）、cu_asc（CU数升序）、cu_desc（CU数降序）四种排序。 | | tags | 否 | String | 查询根据标签进行过滤。 | #### 请求消息 无请求参数。 #### 响应消息 表3响应参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | is_success | 否 | Boolean | 请求执行是否成功。"true"表示请求执行成功。 | | message | 否 | String | 系统提示信息，执行成功时，信息可能为空。 | | queues | 否 | Array of Object | 队列信息。具体请参考[表4]。 | 表4queues参数 | 参数名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | queue_id | 否 | Long | 队列ID。 | | queue_name | 否 | String | 队列名称。 | | description | 否 | String | 队列描述信息。 | | owner | 否 | String | 创建队列的用户。 | | create_time | 否 | Long | 创建队列的时间。单位为"毫秒"的时间戳。 | | queue_type | 否 | String | 队列的类型。 - sql - general - all 如果不指定，默认为"sql"。 | | engine | 否 | String | 引擎类型。 支持配置spark引擎。 | | used_cu | 否 | Float | 队列已使用的CU。 | | cu_count | 否 | Integer | 与该队列绑定的计算单元数，即当前队列的CU数。 | | charging_mode | 否 | Integer | 队列的收费模式。 - 0：系统默认default队列。按照扫描量计费。 - 1：表示按照CU时收费。 - 2：表示按照包年包月收费。 | | resource_id | 否 | String | 队列的资源ID。 | | enterprise_project_id | 否 | String | 企业项目ID。0"表示default，即默认的企业项目。关于如何设置企业项目请参考《[企业管理用户指南](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0108763975.html)》。 说明： 开通了企业管理服务的用户可设置该参数绑定指定的项目。 | | cidr_in_vpc | 否 | String | 队列的虚拟私有云（VPC）的网段。例如：10.0.0.0/8\~24，172.16.0.0/12\~24，192.168.0.0/16\~24。 | | cidr_in_mgntsubnet | 否 | String | 管理子网的网段。 | | cidr_in_subnet | 否 | String | 子网网段。 | | resource_mode | 否 | Integer | 资源模式。 - 0：共享队列 - 1：专属队列 | | platform | 否 | String | 队列计算资源的cpu架构。 - x86_64 - aarch64 | | is_restarting | 否 | Boolean | 是否重启队列。默认值为"false"。 | | labels | 否 | String | 创建队列的标签信息。 | | feature | 否 | String | 队列的镜像类型。支持以下两种类型： - basic：基础型 默认值为"basic"。 说明： AI增强型即队列加载了AI镜像，该镜像在基础镜像的基础上集成了AI相关的算法包。 | | resource_type | 否 | String | 队列所属资源类型。 - vm：ecf集群 - container：容器化集群（k8s） | | cu_spec | 否 | Integer | 队列的规格大小。对于包周期队列，表示包周期部分的CU值；对于按需队列，表示用户购买队列时的初始值。 | | cu_scale_out_limit | 否 | Integer | 当前队列弹性扩缩容的CU值上限。 | | cu_scale_in_limit | 否 | Integer | 当前队列弹性扩缩容的CU值下限。 | | elastic_resource_pool_name | 是 | String | 弹性资源池名称。 | | support_spark_versions | 否 | Array\[String\] | 队列支持的Spark版本。 | | default_spark_version | 否 | String | 队列默认的Spark版本。 | | support_flink_sql_versions | 否 | Array\[String\] | 队列支持的Flink SQL版本。 | | default_flink_sql_version | 否 | String | 队列默认的Flink SQL版本。 | | support_flink_jar_versions | 否 | Array\[String\] | 队列支持的Flink JAR版本。 | | default_flink_jar_version | 否 | String | 队列默认的Flink JAR版本。 | | support_opensource_flink_versions | 否 | Array\[String\] | 队列支持的Flink Opensource SQL版本。 | #### 请求示例 无 #### 响应示例 ``` { "is_success": true, "message": "", "queues": [ { "queue_name": "test", "owner": "testuser", "description": "", "create_time": 1562221422671, "queue_type": "sql", "cu_count": 16, "charging_mode": 2, "resource_id": "26afb850-d3c9-42c1-81c0-583d1163e80f", "enterprise_project_id": "0", "cidr_in_vpc": "10.0.0.0/8", "cidr_in_subnet": "10.0.0.0/24", "cidr_in_mgntsubnet": "10.23.128.0/24", "resource_mode": 1, "platform": "x86_64", "is_restarting": false, "labels": "multi_az=2", "resource_type": "vm", "cu_spec": 16, "elastic_resource_pool_name": "elastic_pool_1" } ] } ``` #### 状态码 状态码如[表5]所示。 表5状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | | 400 | 请求错误。 | | 500 | 内部服务器错误。 | #### 错误码 调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。