查询所有队列

功能介绍

该API用于列出该project下所有的队列。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

• 如果使用角色与策略授权，具体权限要求请参见权限及授权项说明。
• 如果使用身份策略授权，需具备如下身份策略权限。

  授权项 Action	访问级别 Access Level	资源类型（*为必须） Resource Type (*: required)	条件键 Condition Key	别名 Alias	依赖的授权项 Dependencies
  dli:queue:list	List	queue *	-	-	-
  		-	g:RequestTag/<tag-key> g:TagKeys	-	-

URI

• URI格式：

  GET /v1.0/{project_id}/queues

• 参数说明

  表1 URI参数

  参数名称	是否必选	参数类型	说明
  project_id	是	String	项目编号，用于资源隔离。获取方式请参考获取项目ID。

  表2 query参数

  参数名称	是否必选	参数类型	说明
  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	查询根据标签进行过滤。
  limit	否	Integer	分页查询数量。
  offset	否	Integer	分页查询偏移量。

请求消息

无请求参数。

响应消息

请求示例

无

响应示例

{
      "is_success": "true",
      "message": "",
      "queues": [
          {
              "queue_name": "test",
              "owner": "testuser",
              "description": "",
              "create_time": 1562221422671,
              "queue_type": "spark",
              "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
          }
       ]      
    }

状态码

状态码如表5所示。

错误码

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