此手册用于记录大数据开发与管理平台中，EasyConsole子产品所有对外开放的OpenAPI，阅读此手册，你将了解EasyConsole子产品开放的OpenAPI能力与调用方法。

一、控制台公共参数

1.1 响应格式

名称 类型 描述
code Number 响应码
reqId String 请求ID
cost Number 耗时，单位：ms
msg String 响应消息
result Object 响应结果

1.2 响应码

1.2.1 系统正常码
响应码 说明
0 服务器正确处理请求
1.2.2 系统异常码（小于0）
响应码 说明
-1 服务器错误，空指针、数组越界等非业务代码抛出异常
-2 非法请求，参数异常、参数格式错误等接口的请求非法性抛出的通用错误
-3 用户不在当前项目
-4 用户未登录（或者会话无效），且该接口需要登录
-5 加锁失败
-6 签名无效
-7 无可用项目
1.2.3 业务公共异常码（1000 ～ 1999）
响应码 说明
1001 操作失败
1002 客户端操作失败（SDK使用）
1003 无权限
1004 资源不存在
1005 资源已存在
1.2.4 子产品操作异常码（2000 ～ 2999）
响应码 说明
2000 老流协调用异常
2001 新流协调用异常
2050 离线开发调用异常
2100 元数据中心调用异常
2150 BdmsMeta调用异常
2200 安全中心调用异常
2250 向安全中心推送审计日志异常
1.2.5 平台管理状态码异常码（3000 ～ 3199）
响应码 说明
3000 平台管理公共异常
3001 平台模块查询异常
3002 平台K8s运行模式已关闭异常
1.2.6 租户状态异常码（3200 ～ 3399）
响应码 说明
3201 租户数据源配置异常
1.2.7 集群状态异常码（3400 ～ 3599）
响应码 说明
1.2.8 项目状态异常码（3600 ～ 3799）
响应码 说明
3600 项目公共异常
3601 项目下信息查询异常
3602 项目信息更新异常
3603 项目未启用k8s模式异常
3604 项目下k8s镜像查询失败异常
3605 项目集群信息不存在异常
1.2.9 角色状态码（3800 ～ 3999）
响应码 说明
无 无
1.2.10 用户状态码（4000 ～ 4199）
响应码 说明
4000 用户公共异常
4001 用户信息查询异常
4002 用户信息更新异常
4003 用户未加入项目异常
1.2.11 资源状态码（4200 ～ 4399）
响应码 说明
4200 资源公共异常
4201 资源信息查询异常

1.3 枚举列表

暂无

1.4 请求参数列表

1.4.1 用户有权限的Yarn队列查询参数

UserYarnQueueParam

指定项目集群下，用户有权限的Yarn队列信息查询参数

字段 类型 描述 是否必填 默认值
product String 项目名称 是
clusterId String 集群id 是
env String 环境：dev-开发，online-线上 是
user String 项目名称 是
pageNum Number 第几页 否 1
pageSize Number 每页条数 否 25
keyword String 检索关键字，支持queueName检索 否 NULL

1.5 响应实体列表

1.5.1 基础实体

PaginationDto

描述：分页查询结果

字段 类型 描述
pageSize Number 每页显示条数
pageNum Number 页数
totalCount Number 总条数
totalPage Number 总页数
list List<Object> 当前页结果
1.5.2 Yarn队列实体

YarnQueueSetting

描述：Yarn队列弹性配置信息

字段 类型 描述
maxCPU Number 最大可用CPU vcore数量
maxMemGB Number 最大可用内存大小，单位：GB
maxRunningApps Number 最大任务并行数
startHour Number 队列配置生效开始时间，小时，范围为 0-23，左闭右开
endHour Number 队列配置生效结束时间，小时，范围为 1-24，左闭右开

YarnQueueDetailDto

描述：Yarn队列信息实体

字段 类型 描述
queueName String Yarn队列名称
queueFullName String Yarn队列全路径名称
maxCPU Number 当前时间节点队列最大可用CPU vcore数量
maxMemGB Number 当前时间节点队列最大可用内存大小，单位：GB
yarnId String Yarn集群唯一标识
yarnName String Yarn集群名称
queueType String 队列类型： sla-sla队列 、ntv-native队列

二、OpenAPI列表

2.1 OpenApi总览

模块 请求方法 版本 状态 API路径 名称
队列 POST v1.2.14 待上线 /yarn-queue/v1/user-privileged/list 查询离线开发模式下用户有权限的Yarn队列列表

2.2 Yarn队列

2.2.1 分页查询用户有权限的Yarn队列列表

POST /yarn-queue/v1/user-privileged/list

产品版本：v1.2.14

描述：分页查询离线开发模式下用户有权限的Yarn队列列表

分页排序规则：按queueName升序排序

URL参数/请求体

名称 类型 描述 必填 默认值
product String 项目名称 是
clusterId String 集群id 是
env String 环境：dev-开发，online-线上 是
user String 用户邮箱 是
pageNum Number 第几页 否 1
pageSize Number 每页条数 否 25
keyword String 检索关键字，支持queueName检索，该参数传空白字符串或者不传则查询所有 否 NULL

请求示例：

{

"product": "intern",

"clusterId": "dev4",

"env": "dev",

"user": "dummy@corp.netease.com",

"pageNum": 1,

"pageSize": 25,

"keyword": null

}

响应体

名称 类型 描述 必传
code Number 状态码 是
msg String 错误信息 是
cost Number 接口消耗毫秒数 是
reqId String 请求ID 是
result PaginationDto<YarnQueueDetailDto> 队列列表 是

响应示例：

{

"code": 0,

"msg": null,

"cost": 5,

"reqId": "d46111fff56a4bcaba0d9bedb0566ec8",

"result": {

    "pageNum": 1,

    "pageSize": 25,

    "totalCount": 100,

    "totalPage": 4,

    "list": \[

        {

            "queueName": "gaolong\_test\_test\_test",

            "queueFullName": "root.gaolong\_test\_test\_test.default",

             "maxCPU": 100,

             "maxMemGB": 200,

             "yarnId": "default",

             "yarnName": "默认Yarn集群",

             "queueType": "sla"        

        }       

    \]                                                                                         

}

}