无标题文章

    
      
        API
        
        

        
        
        
        
        

      
      
        

目录


  1. 未命名接口

  2. 创建用户组

  3. 修改用户组

  4. 查询用户所在的用户组

  5. 创建实例(旧)

  6. 修改实例(旧)

  7. 批量删除实例接口(旧)

  8. 批量创建对象实例

  9. 查询模型工具盒子列表

  10. 新建修改任意门工具列表

  11. 创建单个任意门工具盒子

  12. 修改指定模型单个任意门信息

  13. 获取指定模型单个任意门信息

  14. 修删除指定模型单个任意门

  15. 修改模型任意门状态

  16. 获取模型任意门状态

  17. 管理员查询用户

  18. 管理员修改用户信息

  19. 管理员查询所有用户信息

  20. 管理员删除用户信息

  21. 管理员禁用用户

  22. 管理员解禁用户

  23. 用户ID列表查询

  24. 用户ID/昵称映射列表查询

  25. 查询用户登录信息

  26. 查询所有org

  27. 查询设备列表

  28. 自动注册设备信息

  29. 根据设备查应用

  30. 查询设备信息,支持批量

  31. 用户注册接口

  32. 绑定流水线

  33. 解绑流水线

  34. 列出流水线

  35. 查询流水线

  36. 修改流水线

  37. 根据key value查询集群列表

  38. 批量获取集群列表

  39. 根据应用获取集群列表

  40. 获取集群信息

  41. 安装agent

  42. 查询安装结果

  43. 获取agent安装密钥

  44. 获取agent代理安装脚本

  45. 获取agent安装脚本

  46. 查询邀请码

  47. 重置邀请码

  48. 创建集群

  49. 修改集群

  50. 删除集群

  51. 集群添加设备

  52. 解除集群关联设备

  53. 集群关联包

  54. 解除集群关联包

  55. 修改集群关联包

  56. 管理员修改用户信息

  57. 用户邀请注册

  58. 分页查询apikey

  59. 创建apikey

  60. 重置apikey

  61. 启用apikey

  62. 禁用apikey

  63. 删除apikey

  64. 获取所有密钥对

  65. 获取密钥对

  66. 添加密钥对

  67. 修改密钥对

  68. 删除密钥对

  69. 创建订阅规则

  70. 修改订阅规则

  71. 删除订阅规则

  72. 获取订阅规则

  73. 查询关系查询策略是否被订阅规则使用

  74. 发送邮件

  75. 用户登录

  76. 发现基础拓扑节点信息

  77. 查询基础拓扑节点信息

  78. 删除基础拓扑节点信息

  79. 创建基础拓扑节点信息

  80. 更新基础拓扑节点信息

  81. 查询拓扑信息

  82. 创建拓扑信息

  83. 更新拓扑信息

  84. 删除拓扑信息

  85. 获取应用信息

  86. 创建应用

  87. 修改应用

  88. 删除应用

  89. 应用关联程序包

  90. 应用解除关联包

  91. 修改应用关联包

  92. 程序包排序

  93. 创建文档

  94. 修改文档

  95. 查询文档

  96. 查询所有文档

  97. 删除文档

  98. 搜索文档

  99. 通过用户 instanceId 或者用户组 instanceId发送邮件

  100. 查询单个资源模型

  101. 分页查询资源模型

  102. 创建资源模型

  103. 修改资源模型

  104. 删除资源模型

  105. 引用对象反向查询接口

  106. 添加资源模型属性

  107. 查询资源模型属性列表

  108. 获取资源模型属性

  109. 删除资源模型属性

  110. 修改资源模型属性

  111. 查询剩余可自定义对象数量

  112. 查询图标和模型对应关系

  113. 新建实例手动审计日志记录

  114. 新建实例自动巡检审计日志记录

  115. 用户组ID列表查询

  116. 用户组ID名称映射列表查询

  117. 全文搜索接口

  118. 全文搜索接口

  119. 单个实例查询接口

  120. 分页查询实例

  121. 分页查询归档实例

  122. 归档实例

  123. 激活实例

  124. 实例搜索接口

  125. 引用实例反向查询接口

  126. 查询单个实例约束接口

  127. 业务创建接口

  128. 主机创建接口

  129. 单个实例创建接口

  130. 单个实例修改接口

  131. 单个实例删除接口

  132. 获取实例变更日志

  133. 数据导入接口

  134. 批量编辑接口

  135. 获取实例默认值

  136. 处理实例修改后动作

  137. 实时同步全文搜索数据

  138. 刷新冗余数据

  139. 查询业务列表

  140. 查询业务关联链路

  141. 根据一级业务id遍历查询子业务下的所有应用

  142. 查询某个业务的信息

  143. 查询子业务信息

  144. 查询业务信息

  145. 获取用户配置信息namespace

  146. 获取用户配置信息值

  147. 修改用户配置信息值

  148. 获取资源模型下某一属性的值

  149. 更新冗余数据

  150. 多实例查询

  151. 个人信息查询

  152. 查询个人apikey

  153. 修改个人密码

  154. 用户忘记密码

  155. 用户重置密码

  156. 查询应用

  157. 查询应用列表

  158. 获取应用下的设备以及集群信息数量

  159. 批量查询应用信息

  160. 批量获取应用列表

  161. 搜索应用列表


未命名接口



执行查询sql(仅支持查询sql)



- 参数




















名称 类型 必选 备注 默认值
fetchPlan string 获取数据的策略, 默认展开两层的关系数据
http://orientdb.com/docs/2.2.x/Fetching-Strategies.html

- 返回值说明



返回类型: json

int



创建用户组


- 测试关键字


create user group

- 接口访问URL


POST /object/USER_GROUP/instance

- 参数
































名称 类型 必选 备注 默认值
name string 名称
_description string 描述
_members array 组成员

- 返回值说明



返回类型: json

用户组实例id



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例


{
"name": "CMDB开发组",
"_description": "this is a greate team",
"_members": ["56dfea1bc8a96","56dfea253c80f"],
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": "5715e1aa4a014",
"error": "\u6210\u529f"
}

修改用户组


- 测试关键字


modify user group

- 接口访问URL


PUT /object/USER_GROUP/instance/@instance_id

- 参数
































名称 类型 必选 备注 默认值
instance_id string 用户组实例Id
_description string 描述
_members array 组成员

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例


{
"_members": [
"56dfea1bc8a96",
"56dfea253c80f"
],
"_description": "this is a greate team"
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": null,
"error": "\u6210\u529f"
}

查询用户所在的用户组



查询用户组, 支持根据用户查询所在用户组



- 接口访问URL


GET /object/USER_GROUP/instance

- 参数


































名称 类型 必选 备注 默认值
username string 用户名,用分号隔开
page int 页码 1
page_size int 页大小 30

- 返回值说明



返回类型: json

用户与所在的用户组信息



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 请求示例


GET /object/USER_GROUP/instance?username=light;index

创建实例(旧)



deprecated, 因格式问题, 建议弃用



- 测试关键字


create instance old

- 接口访问URL


POST /object/instance/@objectId

- 参数


























名称 类型 必选 备注 默认值
objectId string 资源模型ID
name string 实例名称

- 返回值说明



返回类型: json

创建后的实例Id



修改实例(旧)



deprecated, 因格式问题, 建议弃用



- 测试关键字


modify instance old

- 接口访问URL


PUT /object/instance/@objectId/@instanceId

- 参数
































名称 类型 必选 备注 默认值
objectId string 资源模型ID
instanceId string 实例ID
name string 实例名称

- 返回值说明



返回类型: json

修改后的实例Id



批量删除实例接口(旧)


- 测试关键字


delete instances batch

- 接口访问URL


DELETE /object/instance/@objectId

- 参数


























名称 类型 必选 备注 默认值
objectId string 资源模型ID
ids string 实例Id,用分号隔开

- 返回值说明



返回类型: json

实例Id数组



批量创建对象实例



deprecated 接口已弃用



- 测试关键字


create instance list

- 接口访问URL


POST /object/instance/list/@objectId

- 参数


























名称 类型 必选 备注 默认值
objectId string 资源模型ID
instance_list struct 实例列表

- 返回值说明



返回类型: json

创建成功后的实例id



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


[
{
"name": "\u535a\u5ba2\u5e94\u7528",
"installPath": "/data/easyops/blog/"
}
]

- 返回示例


{
"message": "Success",
"code": 0,
"data": [
"570b535423f98"
],
"error": "\u6210\u529f"
}

查询模型工具盒子列表


- 测试关键字


get object toolkit list

- 接口访问URL


GET /toolkit/tools/@objectId

- 参数




















名称 类型 必选 备注 默认值
objectId string 模型Id

- 返回值说明



返回类型: json

模型工具盒子详情



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET /toolkit/tools/APP

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"toolList": [
{
"style": {
"color": "primary",
"icon": "fa fa-wrench"
},
"type": "tool",
"name": "Test",
"metadata": {
"toolId": "d3d453ab1412cd2102da83ff761a526a",
"params": [
{
"cmdbAttrId": "ip",
"multiple": true,
"name": "@agents",
"showInjectCheckbox": false,
"required": true,
"value": [
"192.168.100.75"
],
"label": "\u6267\u884c\u76ee\u6807",
"cmdbObjectId": "HOST",
"inject": false,
"type": "cmdbInstances",
"instanceIds": [
"5ad79c6288455"
]
}
]
}
}
],
"enabled": true
},
"error": "\u6210\u529f"
}

新建修改任意门工具列表


- 测试关键字


create or modify object toolkit

- 接口访问URL


PUT /toolkit/tools

- 参数
































名称 类型 必选 备注 默认值
enabled string 任意门状态
objectId string 模型Id
toolList array 工具list

- 返回值说明



返回类型: json

json



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


PUT /toolkit/tools
{
"enabled": true,
"objectId": "APP",
"toolList": [
{
"metadata": {
"params": [
{
"cmdbAttrId": "ip",
"cmdbObjectId": "HOST",
"inject": false,
"instanceIds": [
"5ad79c6288455"
],
"label": "执行目标",
"multiple": true,
"name": "@agents",
"required": true,
"showInjectCheckbox": false,
"type": "cmdbInstances",
"value": [
"192.168.100.75"
]
}
],
"toolId": "d3d453ab1412cd2102da83ff761a526a"
},
"name": "Test",
"style": {
"color": "primary",
"icon": "fa fa-wrench"
},
"type": "tool"
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": 0,
"error": "\u6210\u529f"
}

创建单个任意门工具盒子


- 测试关键字


create object one toolkit

- 接口访问URL


POST /toolkit/@objectId

- 参数














名称 类型 必选 备注 默认值
objectId</td> <td>string</td> <td>是</td> <td>模型Id</td> </tr> <tr> <td>name</td> <td>string</td> <td>是</td> <td>任意门名字</td> </tr> <tr> <td>type</td> <td>string</td> <td>是</td> <td>任意门类型</td> </tr> <tr> <td>metadata</td> <td>array</td> <td>否</td> <td>任意门对应资源数据</td> </tr> <tr> <td>style</td> <td>array</td> <td>否</td> <td>任意门显示样式</td> </tr> <tr> <td>ignoreSecondCheck</td> <td>bool</td> <td>否</td> <td>是否忽略二次验证</td> </tr> </tbody> </table> <h3 id=- 返回值说明

返回类型: json
json

- 返回码

返回码 备注
130300 数据库错误
130501 参数不足
0 成功

- 请求示例

POST /toolkit/APP { "name": "Test", "style": { "color": "primary", "icon": "fa fa-wrench" }, "type": "tool" "ignoreSecondCheck": true "metadata": { "params": [ { "cmdbAttrId": "ip", "cmdbObjectId": "HOST", "inject": false, "instanceIds": [ "5ad79c6288455" ], "label": "执行目标", "multiple": true, "name": "@agents", "required": true, "showInjectCheckbox": false, "type": "cmdbInstances", "value": [ "192.168.100.75" ] } ] 

- 返回示例

{ "code": 0, "error": "成功", "message": "Success", "data": { "_id": { "">oid": "5b336a5c59b8ce996928b236"
},
"type": "flow",
"ignoreSecondCheck": true,
"name": "二人若若ddddd",
"style": {
"color": "primary",
"icon": "fa fa-battery-half"
},
"metadata": {
"flowId": "35a62ccebc414d6f5350345111da3879",
"params": [{
"cmdbAttrId": "ip",
"cmdbObjectId": "HOST",
"label": "执行目标",
"multiple": true,
"name": "@agents",
"required": true,
"type": "cmdbInstances",
"showInjectCheckbox": false,
"inject": false,
"rawParamType": "cmdbInstances",
"paramMap": false,
"inputType": "custom",
"value": ["172.17.0.56"],
"instanceIds": ["5b0248704f01b"],
"attrName": "执行目标"
}]
}
}
}
}

修改指定模型单个任意门信息


- 测试关键字


modify object one toolkit

- 接口访问URL


PUT /toolkit/@objectId/@toolkitId

- 参数


















































名称 类型 必选 备注 默认值
toolkitId string 任意门toolkitId
name string 任意门名字
type string 任意门类型
metadata array 任意门对应资源数据
style array 任意门显示样式
ignoreSecondCheck bool 是否忽略二次验证

- 返回值说明



返回类型: json

json



- 返回码



















返回码 备注
130300 数据库错误
0 成功

- 请求示例


PUT /toolkit/APP/5b336a5c59b8ce996928b236
{
"name": "Test",
"style": {
"color": "primary",
"icon": "fa fa-wrench"
},
"type": "tool"
"ignoreSecondCheck": true
"metadata": {
"params": [
{
"cmdbAttrId": "ip",
"cmdbObjectId": "HOST",
"inject": false,
"instanceIds": [
"5ad79c6288455"
],
"label": "执行目标",
"multiple": true,
"name": "@agents",
"required": true,
"showInjectCheckbox": false,
"type": "cmdbInstances",
"value": [
"192.168.100.75"
]
}
]

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": {
"_id": {
"oid

获取指定模型单个任意门信息

- 测试关键字

get object one toolkit info 

- 接口访问URL

GET /toolkit/@objectId/@toolkitId 

- 参数







名称 类型 必选 备注 默认值
">objectId string 模型ID
toolkitId</td> <td>string</td> <td>是</td> <td>任意门资源ID</td> </tr> </tbody> </table> <h3 id=- 返回值说明

返回类型: json
json

- 返回码

返回码 备注
130300 数据库错误
0 成功

- 请求示例

GET /toolkit/APP/5b336a5c59b8ce996928b236 

- 返回示例

{ "code": 0, "error": "成功", "message": "Success", "data": { "_id": { "">oid": "5b336a5c59b8ce996928b236"
},
"type": "flow",
"name": "二人若若ddddd",
"style": {
"color": "primary",
"icon": "fa fa-battery-half"
},
"metadata": {
"flowId": "35a62ccebc414d6f5350345111da3879",
"params": [{
"cmdbAttrId": "ip",
"cmdbObjectId": "HOST",
"label": "执行目标",
"multiple": true,
"name": "@agents",
"required": true,
"type": "cmdbInstances",
"showInjectCheckbox": false,
"inject": false,
"rawParamType": "cmdbInstances",
"paramMap": false,
"inputType": "custom",
"value": ["172.17.0.56"],
"instanceIds": ["5b0248704f01b"],
"attrName": "执行目标"
}]
}
}
}
}

修删除指定模型单个任意门


- 测试关键字


delete object toolkit

- 接口访问URL


DELETE /toolkit/@objectId/@toolkitId

- 参数




















名称 类型 必选 备注 默认值
toolkitId string 任意门toolkitId

- 返回值说明



返回类型: json

json



- 返回码



























返回码 备注
130300 数据库错误
130502 toolkitId格式错误
130308 查询无结果
0 成功

- 请求示例


DELETE /toolkit/APP/5b336a5c59b8ce996928b236

- 返回示例


{
"message": "Success",
"code": 0,
"data": null,
"error": "\u6210\u529f"
}

修改模型任意门状态



状态 开启 关闭



- 测试关键字


set object toolkit status

- 接口访问URL


PUT /toolkit/setting/@objectId

- 参数


























名称 类型 必选 备注 默认值
objectId string 实例ID
enabled string 任意门状态 true false

- 返回值说明



返回类型: json

json



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


PUT /toolkit/setting/APP
{
"enabled": true
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": null,
"error": "\u6210\u529f"
}

获取模型任意门状态


- 测试关键字


get object toolkit setting

- 接口访问URL


GET /toolkit/setting/@objectId

- 参数




















名称 类型 必选 备注 默认值
objectId string 实例ID

- 返回值说明



返回类型: json

json



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET /toolkit/setting/APP

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"enabled": true
},
"error": "\u6210\u529f"
}

管理员查询用户


- 测试关键字


get user by admin

- 接口访问URL


GET /admin/users/@username

- 参数




















名称 类型 必选 备注 默认值
username string 用户名

- 返回值说明



返回类型: json

用户信息



- 返回码















返回码 备注
130300 数据库错误

管理员修改用户信息


- 测试关键字


modify user by admin

- 接口访问URL


PUT /admin/users/@username

- 参数






































名称 类型 必选 备注 默认值
username string 用户名
email string 邮箱
phone string 手机
password string 密码

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

管理员查询所有用户信息


- 测试关键字


get users by admin

- 接口访问URL


GET /admin/users

- 参数






































名称 类型 必选 备注 默认值
page int 页码
pageSize int 页大小
state string 用户可用状态, 枚举型 valid, invalid
name stirng 用户名, 用分号隔开

- 返回值说明



返回类型: json

用户信息列表



- 返回码















返回码 备注
130300 数据库错误

管理员删除用户信息


- 测试关键字


remove user by admin

- 接口访问URL


DELETE /admin/users/@username

- 参数




















名称 类型 必选 备注 默认值
username string 用户名

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

管理员禁用用户



无法禁用自己



- 测试关键字


block user by admin

- 接口访问URL


PUT /admin/users/@username/_block

- 参数




















名称 类型 必选 备注 默认值
username string 用户名

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

管理员解禁用户



无法解禁自己



- 测试关键字


unblock user by admin

- 接口访问URL


PUT /admin/users/@username/_unblock

- 参数




















名称 类型 必选 备注 默认值
username string 用户名

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

用户ID列表查询


- 接口访问URL


GET /users/id

- 参数




















名称 类型 必选 备注 默认值
state string 用户状态valid/invalid, 默认返回所有用户id

- 返回值说明



返回类型: json

用户id列表



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET http://cmdb.easyops-only.com/users/id?state=valid

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": [
"easyops",
"linuschen",
"lightjiao",
"lulutest",
"indexzhuo", * "rufusyang",
"robotname",
"robota",
"index"
]
}

用户ID/昵称映射列表查询


- 接口访问URL


GET /users/id_map_nickname

- 参数




















名称 类型 必选 备注 默认值
state string 用户状态valid/invalid, 默认返回所有用户id

- 返回值说明



返回类型: json

用户id/昵称映射列表



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET http://cmdb.easyops-only.com/users/id_map_nickname?state=valid

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": [
"easyops": "easyops",
"linuschen": "linuschen",
"lightjiao": "lightjiao",
"lulutest": "lulutest",
"indexzhuo": "indexzhuo",
"rufusyang": "rufusyang",
"robotname": "robotname",
"robota": "robota",
"index": "index"
]
}

查询用户登录信息



指定key和value返回用户的登录信息(org和name), 请求这个接口的header里面不需要user和org



- 测试关键字


get user login info

- 接口访问URL


GET /user/login_info

- 参数


























名称 类型 必选 备注 默认值
login_key string 登录的key字符串, 例如SSO登录时候的工号的key
login_value string 登录的值, 例如SSO登录时候的工号的值

- 返回值说明



返回类型: json

用户登录信息的name和org



- 请求示例


GET /user/login_info?login_key=userNo&login_value=12342234

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"org": 8888,
"name": "easyops"
},
"error": "\u6210\u529f"
}

查询所有org



暂时不做自动化测试



- 接口访问URL


GET /org/list

- 返回值说明



返回类型: json

org信息列表



- 返回码















返回码 备注
130300 数据库错误

查询设备列表



@deprecated, 接口较老,不再建议使用



- 测试关键字


search device

- 接口访问URL


GET /device/search

- 参数






















































































名称 类型 必选 备注 默认值
ip string 设备IP
hostname string 主机名
provider string 服务商
deviceId int 设备ID
status string 设备状态
location string 设备状态
user_name string 设备状态
order string 排序字段
fields string 查询字段
ignore string 过滤字段
page int 分页
pageSize int 分页大小

- 返回值说明



返回类型: json

设备列表



自动注册设备信息


- 测试关键字


register device

- 接口访问URL


POST /device/register

- 参数
































名称 类型 必选 备注 默认值
hostname string 主机名
ip string 主机IP
status string 运营状态

- 返回值说明



返回类型: json

null



根据设备查应用



@deprecated接口较老,不再建议使用



- 测试关键字


search app by device_ids

- 接口访问URL


GET /device/app-list

- 参数




















名称 类型 必选 备注 默认值
deviceIdList string 设备id列表,以分号分隔

- 返回值说明



返回类型: json

应用列表



查询设备信息,支持批量



@deprecated, 接口较老,已弃用

高级查询请使用接口POST /object/@object_id/instance/_search



- 测试关键字


get device by key value

- 接口访问URL


GET /v2/device/@key/@val

- 参数


















































名称 类型 必选 备注 默认值
key string
val string
fields string 需要的字段,默认全部返回, 用分号隔开多个字段
ignore string 忽略的字段,默认全部返回, 用分号隔开多个字段
page int 分页
pageSize int 分页大小

- 返回值说明



返回类型: json

设备列表



用户注册接口



注册用户, 提供username, password和org



- 测试关键字


signup

- 接口访问URL


POST /sign_up

- 参数
































名称 类型 必选 备注 默认值
username string 用户名
password string 用户密码
org int 组织id

- 返回值说明



返回类型: json

用户信息



- 返回码















返回码 备注
130300 数据库错误

绑定流水线


- 接口访问URL


POST /application/@app_id/pipeline

- 参数






























































名称 类型 必选 备注 默认值
app_id string 应用ID
name string 流水线名称
flowId string 流程ID
flowVersion int 流程版本ID
templateId string 模板ID
templateVersion int 模板版本ID
rules array 流水线规则
subscribers array 订阅者列表

- 返回值说明



返回类型: json

流水线信息



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 请求示例


{
"name": "",
"flowId": "",
"flowVersion": "",
"templateId": "",
"templateVersion": "",
"rules": {
hooks: { enabled: true },
schedules: { enabled: true },
},
"subscribers": []
}

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": {
"name": "",
"flowId": "",
"flowVersion": "",
"templateId": "",
"templateVersion": "",
"rules": {
hooks: { enabled: true },
schedules: { enabled: true },
},
"subscribers": []
}
}

解绑流水线


- 接口访问URL


DELETE /application/@app_id/pipeline/@flow_id

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": null,
"error": "\u6210\u529f"
}

列出流水线


- 接口访问URL


GET /application/@app_id/pipeline

- 返回值说明



返回类型: json

流水线列表



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"list": [
{
"flowId": "",
"templateId": "",
"templateVersion": "",
"flowVersion": ""
},
{
"flowId": "",
"templateId": "",
"templateVersion": "",
"flowVersion": ""
}
]
},
"error": "\u6210\u529f"
}

查询流水线


- 接口访问URL


GET /application/@app_id/pipeline/@flow_id

- 返回值说明



返回类型: json

流水线列表



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"flowId": "",
"templateId": "",
"templateVersion": "",
"flowVersion": ""
},
"error": "\u6210\u529f"
}

修改流水线


- 接口访问URL


PUT /application/@app_id/pipeline/@flow_id

- 参数


















































名称 类型 必选 备注 默认值
app_id string 应用ID
name string 流水线名称
flowVersion int 流程版本ID
templateVersion int 模板版本ID
rules array 流水线规则
subscribers array 订阅者列表

- 返回值说明



返回类型: json

流水线信息



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 请求示例


{
"templateVersion": "",
"flowVersion": ""
}

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": {
"name": "",
"flowId": "",
"flowVersion": "",
"templateId": "",
"templateVersion": "",
"rules": {
hooks: { enabled: true },
schedules: { enabled: true },
},
"subscribers": []
}
}

根据key value查询集群列表



暂时不做自动化测试



- 接口访问URL


GET /v2/cluster/@key/@val

- 参数


























名称 类型 必选 备注 默认值
key string
val string

- 返回值说明



返回类型: json

集群列表



批量获取集群列表



@deprecated, 接口较老,已弃用

高级查询请使用接口POST /object/@object_id/instance/_search



- 测试关键字


get cluster list by instanceids

- 接口访问URL


GET /clusters/@instanceIds

- 参数


































名称 类型 必选 备注 默认值
instanceIds string instanceId列表,逗号分割,id为空时,获取所有应用列表
page int 当前页码 1
pageSize int 每页大小 30

- 返回值说明



返回类型: json

集群列表



- 返回码















返回码 备注
130300 数据库错误

- 返回示例


{
"code": 0,
"error": "成功",
"message": null,
"data": {
"total": 78,
"list": [
{
"name": "test",
"clusterId": "e71ad9c15fe8a989db8a8912a58d4693",
"packageId": null,
"deviceList": null,
"appId": {
"appId": "5c9bba099758cb89c7f1d394f6a08286",
"instanceId": "56dff11497f66"
},
"type": "0",
"memo": null,
"instanceId": "56e0a79e8f2fb",
"ctime": "2016-03-10 06:45:50",
"org": 8888,
"mtime": "2016-04-06 14:56:55",
"modifier": "colintest"
}
]
}

根据应用获取集群列表


- 测试关键字


get cluster list by app

- 接口访问URL


GET /cluster/appid/@appId

- 参数
































名称 类型 必选 备注 默认值
appId string 应用ID
page int 页码
pageSize int 每页大小

- 返回值说明



返回类型: json

集群列表



- 返回码















返回码 备注
130300 数据库错误

获取集群信息



@deprecated 接口较老不建议使用,建议使用接口 GET /object/@object_id/instance/@instance_id



- 测试关键字


get cluster info

- 接口访问URL


GET /cluster/@instanceId

- 参数




















名称 类型 必选 备注 默认值
instanceId string 集群id

- 返回值说明



返回类型: json

集群详情



- 返回码















返回码 备注
130300 数据库错误

安装agent



自动安装暂时不纳入自动化测试



- 接口访问URL


POST /agent/install

- 参数












































名称 类型 必选 备注 默认值
ip string 安装agent的目标ip
port string 安装agent的目标端口
username string 机器用户名
password string 机器密码
async bool 是否异步安装

- 返回值说明



返回类型: json

应用详情



- 请求示例


{
"username": "root",
"ip": "192.168.1.2",
"password": "123456",
"port": 22,
"async": true
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {},
"error": "\u6210\u529f"
}

查询安装结果



自动安装暂时不纳入自动化测试



- 接口访问URL


GET /agent/install

- 参数






































名称 类型 必选 备注 默认值
ip string 安装agent的目标ip
port string 安装agent的目标端口
username string 机器用户名
password string 机器密码

- 返回值说明



返回类型: json

结果 status ["run","ok","failed"]



- 请求示例


{
"ip":"192.168.1.2",
"port":22,
"username":"root",
"password":"123456",
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"status": "ok",
"retCode": "0",
"detail": "###SCRIPT_START###\nstart to install...\nCentOS release 6.7 (Final)\nCentOS release 6.7 (Final)\nCentOS release 6.7 (Final)\nstart to download...\nstart to run...\npath is: /usr/local/easyops/pkg/conf/agent/e9c35bb\nthere are monitor logs, package.conf.yaml, and so on. enjoy it\n###result=success&code=0&msg=success###\n###result=success&code=0&msg=ok###\n###CODE#0#CODE###\n###SCRIPT_END###\n"
},
"error": "\u6210\u529f"
}

获取agent安装密钥


- 测试关键字


agent get install key

- 接口访问URL


GET /agent/install_key

- 返回值说明



返回类型: json

agent安装密钥



- 返回码























返回码 备注
130300 数据库错误
130601 权限错误
133015 获取密钥失败

- 返回示例


{
"message": "Success",
"code": 0,
"data": "656a9d406b86b21bfc47340bc1e079f7595e145d",
"error": "\u6210\u529f"
}

获取agent代理安装脚本



暂时不做自动化测试



- 接口访问URL


GET /agent/proxy_install_script

- 返回值说明



返回类型: file

安装脚本文件



- 返回码



















返回码 备注
130202 文件不存在
130205 打开文件错误

获取agent安装脚本


- 测试关键字


agent get install script

- 接口访问URL


GET /agent/install_script/@os

- 参数
































名称 类型 必选 备注 默认值
os string 操作系统
install_key string Agent安装密钥
proxy_ip string 代理地址

- 返回值说明



返回类型: file

安装脚本文件



- 返回码



















返回码 备注
130202 文件不存在
130205 打开文件错误

查询邀请码



根据用户信息获取邀请码



- 测试关键字


get invite code

- 接口访问URL


GET /invitation/code

- 返回值说明



返回类型: json

邀请码及相关信息



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"code": "SAV35SRYV",
"org": 8888,
"_id": "0ddb5877c896f43e8734e10b001e7f1eb92889cd",
"ts": 1492107569,
"expires": "2017-04-17 02:19:29"
},
"error": "\u6210\u529f"
}

重置邀请码


- 测试关键字


reset invite code

- 接口访问URL


PUT /invitation/code/_reset

- 返回值说明



返回类型: json

新的邀请码



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"org": 8888,
"code": "SAV35SRYV",
"ts": 1492107569,
"expires": "2017-04-17 02:19:29"
},
"error": "\u6210\u529f"
}

创建集群


- 测试关键字


create cluster

- 接口访问URL


POST /cluster

- 参数






































名称 类型 必选 备注 默认值
name string 集群名称
appId string 集群所属应用的appId
type string 集群类型
deviceList array 主机列表

- 返回值说明



返回类型: json

instanceId



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例


{
"deviceList": [
"56dfea1bc8a96",
"56dfea253c80f"
],
"type": 1,
"name": "\u535a\u5ba2\u96c6\u7fa4",
"appId": "56dff11497f66"
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": "5715e1aa4a014",
"error": "\u6210\u529f"
}

修改集群


- 测试关键字


update cluster

- 接口访问URL


PUT /cluster/@instanceId

- 参数
































名称 类型 必选 备注 默认值
instanceId string 实例ID
type string 集群类型
name string 集群名称

- 返回值说明



返回类型: json

集群instanceId



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例


{
"name": "\u535a\u5ba2\u5e94\u7528"
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": "5715e1aa4a014",
"error": "\u6210\u529f"
}

删除集群


- 测试关键字


delete cluster

- 接口访问URL


DELETE /cluster/@instanceId

- 参数




















名称 类型 必选 备注 默认值
instanceId string 集群id

- 返回值说明



返回类型: json

instanceId



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

集群添加设备



URL中的clusterId为集群的instanceId; deviceIds 为主机instanceId列表, 用分号隔开



- 测试关键字


add devices to cluster

- 接口访问URL


POST /cluster/@clusterId/device/@deviceIds

- 参数


























名称 类型 必选 备注 默认值
clusterId string 集群实例ID
deviceIds string 主机实例ID列表, 用分号隔开

- 返回值说明



返回类型: json

集群instanceId



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

解除集群关联设备



URL中的clusterId为集群的instanceId; deviceIds 为主机instanceId列表, 用分号隔开



- 测试关键字


delete devices from cluster

- 接口访问URL


DELETE /cluster/@clusterId/device/@deviceIds

- 参数


























名称 类型 必选 备注 默认值
clusterId string 集群实例ID
deviceIds string 主机实例ID列表, 用分号隔开

- 返回值说明



返回类型: json

集群instanceId



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

集群关联包



URL中的ClusterId 为集群InstanceId



- 测试关键字


add package list to cluster

- 接口访问URL


POST /cluster/@clusterId/package

- 参数


























名称 类型 必选 备注 默认值
clusterId string 集群实例ID
package_list struct 包列表

- 返回值说明



返回类型: json

null



- 请求示例


[
{
"packageId": "3d81bc9e85ea9ffc5959303c0ed09780",
"installPath": "/data/test"
}
]

解除集群关联包


- 测试关键字


delete package from cluster

- 接口访问URL


DELETE /cluster/@clusterId/package/@packageIds

- 参数
































名称 类型 必选 备注 默认值
clusterId string 集群实例ID
packageIds string 包ID列表, 用分号隔开
installPath string 包安装路径

- 返回值说明



返回类型: json

null



修改集群关联包


- 测试关键字


update package in cluster

- 接口访问URL


PUT /cluster/@clusterId/package

- 参数






































名称 类型 必选 备注 默认值
clusterId string 应用id
packageId string 包id
installPath string 安装路径
installPathNew string 修改后的安装路径,可选

- 返回值说明



返回类型: json

null



- 请求示例


{
"installPathNew": "data/test1",
"isMaster": "true",
"packageId": "3d81bc9e85ea9ffc5959303c0ed09780",
"installPath": "/data/test"
}

管理员修改用户信息


- 测试关键字


modify user by admin

- 接口访问URL


PUT /admin/users/@name

- 参数






































名称 类型 必选 备注 默认值
name string 用户名
email string 邮箱
phone string 手机
password string 密码

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

用户邀请注册


- 测试关键字


register by invite

- 接口访问URL


POST /users/register

- 参数












































名称 类型 必选 备注 默认值
name string 用户名
password string 密码
email string 邮箱
invite string 邀请码
phone string 电话

- 返回值说明



返回类型: json

注册后用户信息



- 返回码























返回码 备注
130300 数据库错误
133201 邀请码无效
133210 用户名或信息重复

- 请求示例


{
"password": "dev@easyops",
"name": "indexzhuo3",
"invite": "SMRKTSKQY",
"email": "[email protected]"
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"name": "indexzhuo3",
"email_verified": "0",
"userId": "8",
"phone": "18888888888",
"role": "USER",
"phone_verified": "0",
"mtime": null,
"org": "1040",
"email": "[email protected]",
"ctime": "2016-02-19 13:22:11"
},
"error": "\u6210\u529f"
}

分页查询apikey


- 测试关键字


list apikey

- 接口访问URL


GET /apikey

- 参数


























名称 类型 必选 备注 默认值
page int 页码
page_size int 页大小

- 返回值说明



返回类型: json

apikey列表



- 返回码















返回码 备注
130300 数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"total": 2,
"list": [
{
"access_key": "60ff85cf36510cd2ba91bd64",
"ctime": "2017-01-10 17:34:57",
"ts": 1490752672,
"state": "valid",
"user": "openapi",
"org": 8888,
"secret_key": "72261ec386cffc7597aa81530a606435e2ce26a181fca7a7749bf3ed70355812"
},
{
"access_key": "e7b6a060b55b42713332b93c",
"ctime": "2017-03-29 10:11:38",
"ts": 1490753498,
"state": "valid",
"user": "lightjiao11",
"org": 8888,
"secret_key": "f1ede17ef5078a9ef62fa0a113b43a710820257700ff67ae9b6a29eed891ec5a"
}
],
"page": 1,
"page_size": 30
},
"error": "\u6210\u529f"
}

创建apikey


- 测试关键字


create apikey

- 接口访问URL


POST /apikey

- 参数




















名称 类型 必选 备注 默认值
username string 用户名

- 返回值说明



返回类型: json

apikey信息



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


{
"username": "lightjiao11",
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"access_key": "e7b6a060b55b42713332b93c",
"ctime": "2017-03-29 10:11:38",
"ts": 1490753498,
"state": "valid",
"user": "lightjiao11",
"org": 8888,
"secret_key": "f1ede17ef5078a9ef62fa0a113b43a710820257700ff67ae9b6a29eed891ec5a"
},
"error": "\u6210\u529f"
}

重置apikey


- 测试关键字


reset apikey

- 接口访问URL


POST /apikey/_reset

- 参数




















名称 类型 必选 备注 默认值
username string 用户名

- 返回值说明



返回类型: json

apikey信息



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


{
"username": "lightjiao11",
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"access_key": "e7b6a060b55b42713332b93c",
"ctime": "2017-03-29 10:11:38",
"ts": 1490753498,
"state": "valid",
"user": "lightjiao11",
"org": 8888,
"secret_key": "f1ede17ef5078a9ef62fa0a113b43a710820257700ff67ae9b6a29eed891ec5a"
},
"error": "\u6210\u529f"
}

启用apikey



根据access_key启用apikey, 启用后apikey的state值为valid



- 测试关键字


enable apikey

- 接口访问URL


PUT /apikey/@access_key/_enable

- 参数




















名称 类型 必选 备注 默认值
access_key string access_key

- 返回值说明



返回类型: json

apikey信息



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


PUT /apikey/e7b6a060b55b42713332b93c/_enable

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"access_key": "e7b6a060b55b42713332b93c",
"ctime": "2017-03-29 10:11:38",
"ts": 1490753498,
"state": "valid",
"user": "lightjiao11",
"org": 8888,
"secret_key": "f1ede17ef5078a9ef62fa0a113b43a710820257700ff67ae9b6a29eed891ec5a"
},
"error": "\u6210\u529f"
}

禁用apikey



根据access_key禁用apikey, 禁用后apikey的state值为invalid



- 测试关键字


disable apikey

- 接口访问URL


PUT /apikey/@access_key/_disable

- 参数




















名称 类型 必选 备注 默认值
access_key string access_key

- 返回值说明



返回类型: json

apikey信息



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


PUT /apikey/e7b6a060b55b42713332b93c/_disable

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"access_key": "e7b6a060b55b42713332b93c",
"ctime": "2017-03-29 10:11:38",
"ts": 1490753498,
"state": "invalid",
"user": "lightjiao11",
"org": 8888,
"secret_key": "f1ede17ef5078a9ef62fa0a113b43a710820257700ff67ae9b6a29eed891ec5a"
},
"error": "\u6210\u529f"
}

删除apikey


- 测试关键字


delete apikey

- 接口访问URL


DELETE /apikey/@access_key

- 参数




















名称 类型 必选 备注 默认值
access_key int access_key

- 返回值说明



返回类型: json

json



- 返回码















返回码 备注
130300 数据库错误

- 返回示例


{
"message": "\u5220\u9664OpenAPI Key\u5931\u8d25",
"code": 130308,
"data": null,
"error": "\u67e5\u8be2\u65e0\u7ed3\u679c"
}

获取所有密钥对


- 测试关键字


get keypair page

- 接口访问URL


GET /v1/key_pairs

- 参数
































名称 类型 必选 备注 默认值
company string 云提供商
page int 页码
pageSize int 每页数量

- 返回值说明



返回类型: json

KeyPair列表



- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"total": 1,
"list": [
{
"name": "aws_easyops",
"login_private_key": "nogpoMJBuTdbGhoM1sgI2aIxqRO2bhG87/SEYKhhsQ0FMzdUUbFiEIfy4arCNe3SrGkH6wmsrEd2zjKLVrx1UTHDBG9uXXkZXnNcvgKmoibLAXwyIrjLIe5nu+TnWp91CsXqibBF7S6PUJrUSBul2awcXtNo8bxSl2ilRSbcvQxDlsWihbdFpJveXwVtldyNmRZ3t5dm3E3hWxGAQpoGy/vJGlrzJabCBZZjQk4zbXaunK3FhxP/FxvkZkWXGBG5k7WQZ0LDYetjbKpVqmwbf91HVB0mKGT9fpEIv9PfrqAVMB3mQHxUfcV6L2xnvzt3AJOEzTz5WAonuVxNoyO+dqszXh/28QW6HXNBOtau7Xzp90mWyqLvd2E/uRChA5se0gW6lnO10c2bs6BdwyMjtjTe7PR341hTLLv4k3znmmuI/k9tERpssDWVOO14nanxgEKLK3AlB41hwdMfJKbuCShfl6cc6m0CeqwwnsuzDqU1P1PKv8WVLO9IJuqBNmGH1jq+wme5GR5Izwxzw9SICoWq0kxDoySajfS771d8YmZHJTR0/f3bJYHl6rSpAUVWp4Mtw/bvpRcTstPUCizS8IlQjaLxfcVBYKrGAQNaLDAKDEZ9jh86g/cCh2De5nFS22MVLh4KWVrb7/abxaCYX051h5yBcpNZVdJUTaHCGknrkuQV2jWvaoMo67HIYGxIt/rca1CZOlStsnWpMaiN2oYrcB16fL7pmGSrzs0Ynifw2JA4wtjFGe+fpmsLvTeNuY7oZQeu3KtdBwSIke+hOn4TQ/6/MNQxcmewSMZVJOTD8CwrIoz0MQuQdn4p8zMgLJXk4iOQfV2C3LDxK9xp3rtqM4MJXhWDxBjZ5LKCn75iAiZ7JS/Sz1gTM3aaHo+M1hsqMMMNnjgkLhKn7CpCMZ9+VeHfrYLfeckP6BSWlE39864lwyDNOA17XZ2SxbAi7mlXkTUHIHAjw5zfccVWdPAsidbdeyeijLe0eVS5JrRTcU2+KIxd3y/rwldo4EHZIQ9doDQmyQlRfL2FGEn+I3JUKaLCF08vUXuaq6p0sD61c2oISV8W2Yr94Hmo2bzPc/1RU9v2MPARhhl6cYO8svTsMvttP+f/RnwKp+A3DF427v3tor3H/w0tJ3BQ127VXIfdp1D3FLA8/sFj3tY6gRDVyzLxS+2HeMbCc2XFfTnHA1UgEsM/9GIdBKnPzkb6FgEi0eqA+kjcq3YPCRhuKK9UMSJ0C6NFe1sxJNCel8U6juTcIOXvpX3hEqERcqSOoHqGHAJsCZZcRyv1Mh1rmWL4D7HSmiy+LWzF7dV3xROvfRBJ84kO3MJDFAUtjAkkV0GJj3e302voZP9nYm/f1uqtOii5tlzJEkDKcPkWXPQF5Mr/NJEQBFuYlapLzXyQVHMq8OBb8LhII3rBeVZ3l7ypLnA+S+Xat+u8PQRwtrZouaFchHqC9AxIgB0BJzCfTck/cfgE2oQ+eS2ZRSgGrqPvcXBcYX16p8Q/j9aNsJ/sKaZqHWoNepsBcTPax6CGWIJKoT97nxmPzxqla5Pck2sVwPEL4RWnNVKqsqLu+GrXy2AFBXuLwEZjmFaAqlsUzyMdtMBgw3gk+n4OyEyclphbavBZ9kOynz69UilsScIw1JS8hnyzfitPYohHsUV9fWVuink+fDbg5W5AyAx94wEASJSLxsp/aG7ZqydYA2knsk4NNy6oHop2mCKXz9f36Nl1T6tDQHihejpUuK/Rhy878jsu/TWQ5pqgg5dU5lNl4D06KV7DPJL48o585FUQjHt6rFB0ZozjHY4+slocc6Bi9Aavtvlz4+l7LksTGFRLrZ6TIh9QPBPOUE2/JDmKXjsK3AXHibIFvAjaX9HnL+7JwLzPrTXk9f2BxAjwquy+T0T3x7G1Ro/yYlqjoShE+jC4fnmvks63CqPdiooT82uD9ZQovPxVevjRTU9KuVsJ13du7xobUAeNPNRVfLp2eAduzCCyMUOrTTjDLzK28r34Ss1qfL2PqGDMaiDpSdl3g2WWTjpZ+tymsN5Ao2P5usjbdSDOGjkTzR3UEnrwG1h90SYHtya5cD7VM6XWbCB678SHBrA5z6pYJWIAzURwokztW54edMY6NXKFTgOywdhzKCaP4Py+pa9aK1ry8sUJvjhOWlFaLeYM+smDMfv8Crtbyu4+C78fzVfekQiLdz4eM8WHF+VBgipPYFH0foc7fd6GzD5ElWNkukTu/9GCC8doF/hReZSY63tCXjxcgw==",
"company": "Amazon Web Services",
"mtime": null,
"state": "valid",
"secret": "aj/iQM6W33fx3QMZvmDPW6ESXYbAAjndw4iJaoCITFeKV5vpmfomCczMQ91no7cQ",
"org": 8888,
"key_id": "AKIAPDBJETHSWZKAZXPQ",
"_id": "58b14c0959b8ce640b1e59c7",
"ctime": "2017-02-25 17:19:05"
}
],
"page": 0,
"pageSize": 200
},
"error": "\u6210\u529f"
}

获取密钥对



参数中的id为Mongo数据库中的 _id



- 测试关键字


get keypair

- 接口访问URL


GET /v1/key_pairs/@id

- 参数




















名称 类型 必选 备注 默认值
id string 密钥对的 _id

- 返回值说明



返回类型: json

密钥对数据



- 返回码















返回码 备注
130300 默认数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"name": "aws_easyops",
"login_private_key": "nogpoMJBuTdbGhoM1sgI2aIxqRO2bhG87/SEYKhhsQ0FMzdUUbFiEIfy4arCNe3SrGkH6wmsrEd2zjKLVrx1UTHDBG9uXXkZXnNcvgKmoibLAXwyIrjLIe5nu+TnWp91CsXqibBF7S6PUJrUSBul2awcXtNo8bxSl2ilRSbcvQxDlsWihbdFpJveXwVtldyNmRZ3t5dm3E3hWxGAQpoGy/vJGlrzJabCBZZjQk4zbXaunK3FhxP/FxvkZkWXGBG5k7WQZ0LDYetjbKpVqmwbf91HVB0mKGT9fpEIv9PfrqAVMB3mQHxUfcV6L2xnvzt3AJOEzTz5WAonuVxNoyO+dqszXh/28QW6HXNBOtau7Xzp90mWyqLvd2E/uRChA5se0gW6lnO10c2bs6BdwyMjtjTe7PR341hTLLv4k3znmmuI/k9tERpssDWVOO14nanxgEKLK3AlB41hwdMfJKbuCShfl6cc6m0CeqwwnsuzDqU1P1PKv8WVLO9IJuqBNmGH1jq+wme5GR5Izwxzw9SICoWq0kxDoySajfS771d8YmZHJTR0/f3bJYHl6rSpAUVWp4Mtw/bvpRcTstPUCizS8IlQjaLxfcVBYKrGAQNaLDAKDEZ9jh86g/cCh2De5nFS22MVLh4KWVrb7/abxaCYX051h5yBcpNZVdJUTaHCGknrkuQV2jWvaoMo67HIYGxIt/rca1CZOlStsnWpMaiN2oYrcB16fL7pmGSrzs0Ynifw2JA4wtjFGe+fpmsLvTeNuY7oZQeu3KtdBwSIke+hOn4TQ/6/MNQxcmewSMZVJOTD8CwrIoz0MQuQdn4p8zMgLJXk4iOQfV2C3LDxK9xp3rtqM4MJXhWDxBjZ5LKCn75iAiZ7JS/Sz1gTM3aaHo+M1hsqMMMNnjgkLhKn7CpCMZ9+VeHfrYLfeckP6BSWlE39864lwyDNOA17XZ2SxbAi7mlXkTUHIHAjw5zfccVWdPAsidbdeyeijLe0eVS5JrRTcU2+KIxd3y/rwldo4EHZIQ9doDQmyQlRfL2FGEn+I3JUKaLCF08vUXuaq6p0sD61c2oISV8W2Yr94Hmo2bzPc/1RU9v2MPARhhl6cYO8svTsMvttP+f/RnwKp+A3DF427v3tor3H/w0tJ3BQ127VXIfdp1D3FLA8/sFj3tY6gRDVyzLxS+2HeMbCc2XFfTnHA1UgEsM/9GIdBKnPzkb6FgEi0eqA+kjcq3YPCRhuKK9UMSJ0C6NFe1sxJNCel8U6juTcIOXvpX3hEqERcqSOoHqGHAJsCZZcRyv1Mh1rmWL4D7HSmiy+LWzF7dV3xROvfRBJ84kO3MJDFAUtjAkkV0GJj3e302voZP9nYm/f1uqtOii5tlzJEkDKcPkWXPQF5Mr/NJEQBFuYlapLzXyQVHMq8OBb8LhII3rBeVZ3l7ypLnA+S+Xat+u8PQRwtrZouaFchHqC9AxIgB0BJzCfTck/cfgE2oQ+eS2ZRSgGrqPvcXBcYX16p8Q/j9aNsJ/sKaZqHWoNepsBcTPax6CGWIJKoT97nxmPzxqla5Pck2sVwPEL4RWnNVKqsqLu+GrXy2AFBXuLwEZjmFaAqlsUzyMdtMBgw3gk+n4OyEyclphbavBZ9kOynz69UilsScIw1JS8hnyzfitPYohHsUV9fWVuink+fDbg5W5AyAx94wEASJSLxsp/aG7ZqydYA2knsk4NNy6oHop2mCKXz9f36Nl1T6tDQHihejpUuK/Rhy878jsu/TWQ5pqgg5dU5lNl4D06KV7DPJL48o585FUQjHt6rFB0ZozjHY4+slocc6Bi9Aavtvlz4+l7LksTGFRLrZ6TIh9QPBPOUE2/JDmKXjsK3AXHibIFvAjaX9HnL+7JwLzPrTXk9f2BxAjwquy+T0T3x7G1Ro/yYlqjoShE+jC4fnmvks63CqPdiooT82uD9ZQovPxVevjRTU9KuVsJ13du7xobUAeNPNRVfLp2eAduzCCyMUOrTTjDLzK28r34Ss1qfL2PqGDMaiDpSdl3g2WWTjpZ+tymsN5Ao2P5usjbdSDOGjkTzR3UEnrwG1h90SYHtya5cD7VM6XWbCB678SHBrA5z6pYJWIAzURwokztW54edMY6NXKFTgOywdhzKCaP4Py+pa9aK1ry8sUJvjhOWlFaLeYM+smDMfv8Crtbyu4+C78fzVfekQiLdz4eM8WHF+VBgipPYFH0foc7fd6GzD5ElWNkukTu/9GCC8doF/hReZSY63tCXjxcgw==",
"company": "Amazon Web Services",
"mtime": null,
"state": "valid",
"secret": "aj/iQM6W33fx3QMZvmDPW6ESXYbAAjndw4iJaoCITFeKV5vpmfomCczMQ91no7cQ",
"org": 8888,
"key_id": "AKIAPDBJETHSWZKAZXPQ",
"_id": "58b14c0959b8ce640b1e59c7",
"ctime": "2017-02-25 17:19:05"
},
"error": "\u6210\u529f"
}

添加密钥对



添加密钥对的行为为覆盖添加, 即删除掉已经存在的密钥对重新添加, 以company为唯一



- 测试关键字


add keypair

- 接口访问URL


POST /v1/key_pairs

- 参数












































名称 类型 必选 备注 默认值
company string 公司
name string 键值对名称
key_id string 键值对ID
secret string 键值对密码
login_private_key string 登录私钥

- 返回值说明



返回类型: json

创建成功的密钥对信息



- 返回码























返回码 备注
130300 数据库错误
130601 权限错误
130313 重复键错误

修改密钥对



参数中的id为Mongo数据库中的 _id; 提供商不可修改



- 测试关键字


update key pair

- 接口访问URL


PUT /v1/key_pairs/@id

- 参数












































名称 类型 必选 备注 默认值
id string 密钥对的 _id
name string 键值对名称
key_id string 键值对ID
secret string 键值对密码
login_private_key string 登录私钥

- 返回值说明



返回类型: json

修改后的键值对信息



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

删除密钥对



参数中的id为Mongo数据库中的 _id



- 测试关键字


delete key pair

- 接口访问URL


DELETE /v1/key_pairs/@id

- 参数




















名称 类型 必选 备注 默认值
id string 密钥对的 _id

- 返回值说明



返回类型: json

删除的 _id



- 返回码



















返回码 备注
130300 数据库错误
130601 权限错误

创建订阅规则


- 测试关键字


create subscription rule

- 接口访问URL


POST /object/@object_id/subscription

- 参数
























































名称 类型 必选 备注 默认值
object_id string 资源模型ID
type string 规则类型 instance/relation_query_strategy
crontab string 定时任务策略
receive_user array 导出结果接收用户实例Id列表
receive_group array 导出结果接收用户组实例Id列表
relation_query_strategy_id string 关系查询策略Id,当type=relation_query_strategy时,需必填
query_url string 查询结果页URL

- 返回值说明



返回类型: json

订阅规则创建结果



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


POST /object/APP/subscription
{
"type":"instance/relation_query_strategy",
"crontab":"* * * * ",
"receive_user":["5a77377","883a883838"],
"receive_group":["5a5555e5","5a62663"],
"relation_query_strategy_id":"4252535",
"query_url":"https://www.google.com.hk"
}

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": {
"subscription_id": "590bdb58e53ae0061a0ce812",
"object_id": "APP",
"type":"instance/relation_query_strategy",
"crontab":"
* * * ",
"receive_user":["5a77377","883a883838"],
"receive_group":["5a5555e5","5a62663"],
"relation_query_strategy_id":"4252535",
"scheduler_id":"5ade9d2f59b8ce775ed8da3c",
"query_url":"https://www.google.com.hk",
"operator":"easyops",
"ts":"22222222",
}

修改订阅规则


- 测试关键字


modify subscription rule

- 接口访问URL


PUT /object/@object_id/subscription/@subscription_id

- 参数












































名称 类型 必选 备注 默认值
object_id string 资源模型ID
subscription_id string 订阅规则Id
crontab string 定时任务策略
receive_user array 导出结果接收用户实例Id列表
receive_group array 导出结果接收用户组实例Id列表

- 返回值说明



返回类型: json

订阅规则修改结果



- 返回码



















返回码 备注
130300 数据库错误
134000 订阅策略失效

- 请求示例


PUT /object/APP/subscription/535356253
{
"crontab":"
* * * ",
"receive_user":["5a77377","883a883838"],
"receive_group":["5a5555e5","5a62663"],
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"scheduler_id": "5af2cf6e7231367e93b5fa99",
"object_id": "APP",
"ts": 1525862481,
"receive_group": [
"5a5555e5",
"5a62663"
],
"query_url": "https://www.google.com.hk",
"relation_query_strategy_id": "123",
"crontab": "
* * * *",
"operator": "easyops",
"subscription_id": "5af2cf6d7c587",
"_id": {
"oid

删除订阅规则

- 测试关键字

delete subscription rule 

- 接口访问URL

DELETE /object/@object_id/subscription/@subscription_id 

- 参数

名称 类型 必选 备注 默认值
object_id string 资源模型ID
subscription_id string 订阅规则Id

- 返回值说明

返回类型: json
订阅规则删除结果

- 返回码

返回码 备注
130300 数据库错误

- 请求示例

DELETE /object/APP/subscription/535356253 

- 返回示例

{ "message": "Success", "code": 0, "data": null, "error": "\u6210\u529f" } 

获取订阅规则

- 测试关键字

get subscription list 

- 接口访问URL

GET /object/@object_id/subscription/@type/list 

- 参数

名称 类型 必选 备注 默认值
object_id string 资源模型ID
type string 订阅规则type,值为instance或relation_query_strategy,当type=relation_query_strategy时,需有relation_query_strategy_id参数
relation_query_strategy_id string 关系查询策略Id

- 返回值说明

返回类型: json
订阅规则查询结果列表

- 返回码

返回码 备注
130300 数据库错误

- 请求示例

GET /object/APP/subscription/relation_query_strategy/list?relation_query_strategy_id=544444434 

- 返回示例

{ "message": "Success", "code": 0, "data": [ { "scheduler_id": "5ade9d2f59b8ce775ed8da3c", "object_id": "APP", "ts": "22222222", "receive_group": [ "5a5555e5", "5a62663" ], "query_url": "https://www.google.com.hk", "relation_query_strategy_id": "4252535", "crontab": "* * * * *", "operator": "easyops", "subscription_id": "590bdb58e53ae0061a0ce812", "type": "instance/relation_query_strategy", "receive_user": [ "5a77377", "883a883838" ] } ], "error": "\u6210\u529f" } 

查询关系查询策略是否被订阅规则使用

- 测试关键字

check object relation query strategy in use 

- 接口访问URL

GET /object/@object_id/relation_query_strategy/@relation_query_strategy_id/_check_in_use 

- 参数

名称 类型 必选 备注 默认值
object_id string 资源模型ID
relation_query_strategy_id string 策略ID

- 返回值说明

返回类型: json
json

- 返回示例

{ "message": "Success", "code": 0, "data": { "in_use": true }, "error": "\u6210\u529f" } 

发送邮件

- 测试关键字

send mail 

- 接口访问URL

POST /message/email 

- 参数

名称 类型 必选 备注 默认值
sendTo string 目标地址
subject string 邮件标题
msg string 消息内容
cc string 抄送
sendFrom string 发送方地址
sendFromName string 发送方名称
contentType string 发送内容类型, 请参考网址https://en.wikipedia.org/wiki/Media_type, 默认为text/plain

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误

用户登录

用户登录接口

- 测试关键字

login 

- 接口访问URL

POST /login 

- 参数

名称 类型 必选 备注 默认值
uid string 登录id
password string 登录密码

- 返回值说明

返回类型: json
用户信息

- 返回码

返回码 备注
130300 数据库错误

- 请求示例

{ "password": "654321", "uid": "indexzhuo" } 

- 返回示例

{ "message": "Success", "code": 0, "data": { "org": 8888, "name": "indexzhuo" }, "error": "\u6210\u529f" } 

发现基础拓扑节点信息

- 接口访问URL

PUT /topology/base/@type/@node/_discover 

- 参数

名称 类型 必选 备注 默认值
type string 基础拓扑类型
node string 基础拓扑点ID
edge_list array 基础拓扑边信息

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误

查询基础拓扑节点信息

- 接口访问URL

GET /topology/base/@type/@node 

- 参数

名称 类型 必选 备注 默认值
type string 基础拓扑类型
node string 基础拓扑点ID

- 返回值说明

返回类型: json
拓扑节点信息

- 返回码

返回码 备注
130300 数据库错误

删除基础拓扑节点信息

- 接口访问URL

DELETE /topology/base/@type/@node 

- 参数

名称 类型 必选 备注 默认值
type string 基础拓扑类型
node string 基础拓扑点ID

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误

创建基础拓扑节点信息

- 接口访问URL

POST /topology/base/@type/@node 

- 参数

名称 类型 必选 备注 默认值
type string 基础拓扑类型
node string 基础拓扑点ID
edge_list array 基础拓扑边信息

- 返回值说明

返回类型: json
拓扑点ID

- 返回码

返回码 备注
130300 数据库错误

更新基础拓扑节点信息

- 接口访问URL

PUT /topology/base/@type/@node/@version 

- 参数

名称 类型 必选 备注 默认值
type string 基础拓扑类型
node string 基础拓扑点ID
version string 文档版本
edge_list array 基础拓扑边列表

- 返回值说明

返回类型: json
更新后节点信息

- 返回码

返回码 备注
130300 数据库错误

查询拓扑信息

- 接口访问URL

GET /topology/custom/@id 

- 参数

名称 类型 必选 备注 默认值
id string 文档_id

- 返回值说明

返回类型: json
拓扑信息

- 返回码

返回码 备注
130300 数据库错误

创建拓扑信息

- 接口访问URL

POST /topology/custom 

- 参数

名称 类型 必选 备注 默认值
name string 节点名称
nodes array 节点信息
links array 节点链接

- 返回值说明

返回类型: json
创建后的节点ID

- 返回码

返回码 备注
130300 数据库错误

更新拓扑信息

- 接口访问URL

PUT /topology/custom/@id/@version 

- 参数

名称 类型 必选 备注 默认值
id string 文档_id
version string 文档版本
name string 节点名称
nodes array 节点信息
links array 节点链接

- 返回值说明

返回类型: json
更新后的节点信息

- 返回码

返回码 备注
130300 数据库错误

删除拓扑信息

- 接口访问URL

DELETE /topology/custom/@id 

- 参数

名称 类型 必选 备注 默认值
id string 文档_id

- 返回值说明

返回类型: json
null

获取应用信息

- 测试关键字

get app 

- 接口访问URL

GET /app/@instanceId 

- 参数

名称 类型 必选 备注 默认值
instanceId string 实例ID

- 返回值说明

返回类型: json
应用详情

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

创建应用

- 测试关键字

create app 

- 接口访问URL

POST /app 

- 参数

名称 类型 必选 备注 默认值
name string 应用名
owner array 运维负责人实例id列表
developer array 开发负责人实例id列表
tester array 测试负责人实例id列表
businesses string 关联业务实例id
memo string 备注信息

- 返回值说明

返回类型: json
应用实例id

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例

{ "name": "博客应用", "owner": ["56dfea1bc8a96","56dfea253c80f"], "developer": ["56dfea1bc8a96","56dfea253c80f"], "tester": ["56dfea1bc8a96","56dfea253c80f"], "businesses": 56dfea1bc8aab, "memo": "WordPress博客", } 

- 返回示例

{ "message": "Success", "code": 0, "data": "5715e1aa4a014", "error": "\u6210\u529f" } 

修改应用

- 测试关键字

update app 

- 接口访问URL

PUT /app/@instanceId 

- 参数

名称 类型 必选 备注 默认值
instanceId string 应用id
name string 应用名
owner array 运维负责人实例id列表
developer array 开发负责人实例id列表
tester array 测试负责人实例id列表
memo string 备注信息

- 返回值说明

返回类型: json
应用实例ID

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例

{ "runUser": "root:users", "name": "\u535a\u5ba2\u5e94\u7528", "tester": [ "56dfea1bc8a96", "56dfea253c80f" ], "memo": [ "56dfea1bc8a96", "56dfea253c80f" ], "installPath": "/data/easyops/blog/", "owner": [ "56dfea1bc8a96", "56dfea253c80f" ], "developer": [ "56dfea1bc8a96", "56dfea253c80f" ] } 

删除应用

- 测试关键字

delete app 

- 接口访问URL

DELETE /app/@instanceId 

- 参数

名称 类型 必选 备注 默认值
instanceId string 应用id

- 返回值说明

返回类型: json
应用实例ID

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

- 返回示例

{ "message": "Success", "code": 0, "data": "5715e1aa4a014", "error": "\u6210\u529f" } 

应用关联程序包

- 测试关键字

add package list to app 

- 接口访问URL

POST /app/@appId/package 

- 参数

名称 类型 必选 备注 默认值
appId string 应用id
package_list struct 包列表

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例

[ { "isMaster": "true", "packageId": "3d81bc9e85ea9ffc5959303c0ed09780", "installPath": "/data/test" } ] 

应用解除关联包

- 测试关键字

delete package from app 

- 接口访问URL

delete /app/@appId/package/@packageId 

- 参数

名称 类型 必选 备注 默认值
appId string 应用id
packageId string 包id
installPath string 安装包路径

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

修改应用关联包

以packageId 和installPath 组合键标识唯一的程序包做修改

- 测试关键字

update package in app 

- 接口访问URL

PUT /app/@appId/package 

- 参数

名称 类型 必选 备注 默认值
appId string 应用实例ID
packageId string 包id
installPath string 安装路径
installPathNew string 修改后的安装路径,可选
isMaster string 设置是否是主程序包,可选

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例

{ "installPathNew": "data/test1", "isMaster": "true", "packageId": "3d81bc9e85ea9ffc5959303c0ed09780", "installPath": "/data/test" } 

程序包排序

对应用的程序包做排序功能,传入的参数为排序好的该应用的所有程序包

- 测试关键字

update package list in app for sort 

- 接口访问URL

PUT /app/@appId/package_list/_sort 

- 参数

名称 类型 必选 备注 默认值
appId string 应用ID
package_list struct 包列表

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例

[ { "isMaster": "true", "packageId": "3d81bc9e85ea9ffc5959303c0ed09780", "installPath": "/data/test" } ] 

创建文档

接口存在风险,会污染既定的文档数据;
参数中的 data字段只是为了自动化测试方便所添加的, 实际使用场景可以忽略

- 测试关键字

create document in collection 

- 接口访问URL

POST /system/storage/collection/@collectionName/document/@id 

- 参数

名称 类型 必选 备注 默认值
collectionName string 集合名称
id string 文档_id
doc_data string 文档数据内容

- 返回值说明

返回类型: json
创建成功的文档数据

- 返回码

返回码 备注
130300 数据库错误

修改文档

接口存在风险,会污染既定的文档数据
参数中的 data字段只是为了自动化测试方便所添加的, 实际使用场景可以忽略

- 测试关键字

update document in collection 

- 接口访问URL

PUT /system/storage/collection/@collectionName/document/@id 

- 参数

名称 类型 必选 备注 默认值
collectionName string 集合名称
id string 文档_id
doc_data string 文档数据内容

- 返回值说明

返回类型: json
修改成功的文档数据

- 返回码

返回码 备注
130300 数据库错误

查询文档

接口存在风险,会污染既定的文档数据

- 测试关键字

get one document in collection 

- 接口访问URL

GET /system/storage/collection/@collectionName/document/@id 

- 参数

名称 类型 必选 备注 默认值
collectionName string 集合名称
id string 文档_id

- 返回值说明

返回类型: json
文档数据

- 返回码

返回码 备注
130300 数据库错误

查询所有文档

接口存在风险,会污染既定的文档数据

- 测试关键字

get all document in collection 

- 接口访问URL

GET /system/storage/collection/@collectionName/document/all 

- 参数

名称 类型 必选 备注 默认值
collectionName string 集合名称
page int 页码 1
pageSize int 页大小 30

- 返回值说明

返回类型: json
所有文档数据

- 返回码

返回码 备注
130300 数据库错误

删除文档

接口存在风险,会污染既定的文档数据

- 测试关键字

delete document in collection 

- 接口访问URL

DELETE /system/storage/collection/@collectionName/document/@id 

- 参数

名称 类型 必选 备注 默认值
collectionName string 集合名称
id string 文档_id

- 返回值说明

返回类型: json
null

- 返回码

返回码 备注
130300 数据库错误

搜索文档

接口存在风险,会污染既定的文档数据

- 测试关键字

search document in collection 

- 接口访问URL

GET /system/storage/collection/@collectionName/document/search 

- 参数

名称 类型 必选 备注 默认值
collectionName string 集合名称
page int 页码 1
pageSize int 页大小 30

- 返回值说明

返回类型: json
文档数据列表

- 返回码

返回码 备注
130300 数据库错误

通过用户 instanceId 或者用户组 instanceId发送邮件

- 测试关键字

send mail by instanceId 

- 接口访问URL

POST /v2/message/email 

- 参数

名称 类型 必选 备注 默认值
send_to_user array 目标 user instanceId
send_to_group array 目标用户群组 instanceId
subject string 邮件标题
message string 消息内容
cc_to_user array 抄送 user instanceId
cc_to_group array 抄送 group instanceId
send_from_name string 发送方名称
contentType string 发送内容类型, 请参考网址https://en.wikipedia.org/wiki/Media_type, 默认为text/plain

- 返回值说明

返回类型: json
发送邮件结果

- 返回码

返回码 备注
130300 数据库错误
130106 邮件发送失败
130107 用户无邮箱信息
133004 邮箱无效
133011 用户不存在

- 请求示例

{ "send_from_name": "easyops\u544a\u8b66\u901a\u9053", "message": "21:43\u53d1\u751f\u544a\u8b66, \u5e94\u7528\u5165\u6d41\u91cf\u544a\u8b66#\u544a\u8b66\u5bf9\u8c61: luna6 \uff0c\u544a\u8b66\u503c:357.0kbit \u9ad8\u4e8e\u9608\u503c: 80.0kbit, \u5f71\u54cd\u8303\u56f4: luna6", "send_to_group": [ "5a27d75b87abb" ], "send_to_user": [ "5a27608d65834" ], "subject": "\u3010\u544a\u8b66\u301121:43, \u5e94\u7528\u5165\u6d41\u91cf\u544a\u8b66" } 

- 返回示例

{ "code": 130106, "error": "失败", "message": "send email failed", "data": { [ { "instanceId": "5a27608d65834", "name": "lightjiao", "email": "[email protected]", "send_result": 0 }, { "instanceId": "5a27608d65834", "name": "willniu", "email": "[email protected]", "send_result": 130109 }, { "instanceId": "5a27608d65834", "name": "lightjiao", "email": "", "send_result": 130107 } ] } } 

查询单个资源模型

- 测试关键字

get object 

- 接口访问URL

GET /object/@object_id 

- 参数

名称 类型 必选 备注 默认值
object_id string 资源模型ID

- 返回值说明

返回类型: json
资源模型数据

- 返回码

返回码 备注
130300 数据库错误
133114 数据库无结果

- 返回示例

{ "code": 0, "error": "成功", "message": "Success", "data": { "_id": { "">oid": "590bdb58e53ae0061a0ce812"
},
"objectId": "auto_test_object_id_will",
"name": "auto_test_object_name_2",
"category": "test",
"attrList": [...],
"memo": null,
"view": [],
"creator": "easyops",
"delete": "true",
"protected": false,
"ctime": "2017-05-05 09:54:32",
"org": 8888,
"_ts": 1493949277,
"_version": 5,
"_wrong_fks": [
{
"attr_id": "name",
"ref_object_id": "HOST",
"ref_object_exist": False
}
],
"relation_groups" : [
{
"id" : "group_1",
"name" : "关系分组1",
"relations" " [
{"id" : "relation_1", "name" : "关系名称1"},
{"id" : "relation_2", "name" : "关系名称2"}
]
}
]
}
}

分页查询资源模型


- 测试关键字


get object page

- 接口访问URL


GET /object

- 参数


























名称 类型 必选 备注 默认值
page int 页码
pagrSize int 页大小

- 返回值说明



返回类型: json

资源模型列表



创建资源模型


- 测试关键字


create object

- 接口访问URL


POST /object

- 参数
























































名称 类型 必选 备注 默认值
objectId string 资源模型Id
name string 资源模型名称
memo string 资源模型备注
category string 资源模型类别
view string 资源模型的显示
auto_detect string 定时任务Id
icon string 资源模型图标

- 返回值说明



返回类型: json

创建成功的资源模型数据



- 返回码























返回码 备注
130300 数据库错误
130600 权限错误
130313 数据重复

修改资源模型


- 测试关键字


modify object

- 接口访问URL


PUT /object/@object_id

- 参数
























































名称 类型 必选 备注 默认值
object_id string 资源模型ID
name string 资源模型名称
memo string 资源模型备注
category string 资源模型类别
view string 资源模型的显示
auto_detect string 定时任务Id
icon string 资源模型图标

- 返回值说明



返回类型: json

null



- 返回码























返回码 备注
130300 数据库错误
130600 权限错误
130313 数据重复

删除资源模型


- 测试关键字


delete object

- 接口访问URL


DELETE /object/@object_id

- 参数




















名称 类型 必选 备注 默认值
object_id string 资源模型ID

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

引用对象反向查询接口


- 测试关键字


search object ref

- 接口访问URL


GET /object/_ref

- 参数


























名称 类型 必选 备注 默认值
ref_object string 引用对象id
ref_instance string 引用实例id

- 返回值说明



返回类型: json

引用了指定实例或对象的所有对象数据



- 返回码















返回码 备注
130300 数据库错误

添加资源模型属性


- 测试关键字


add attribute to object

- 接口访问URL


POST /object/@object_id/attr

- 参数
















































































名称 类型 必选 备注 默认值
object_id string 资源模型ID
id string 属性ID
name string 属性名称
value array 值类型声明
view array 外键的值在实例详情页面显示的字段
unique bool 是否唯一
required bool 是否必填
readonly bool 是否只读
tag array 标签
tips string 在实例输入框中的提示消息
description string 外键关系属性描述

- 返回值说明



返回类型: json

null



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


POST /object/APP/attr
{
"id" : "my_first_id",
"name" : "我新建的一个ID",
"value" : {
"type" : "str",
"regex" : "",
"default" : "default value",
"default_type" : "function"
},
"unique" : "true",
"required" : "true",
"readonly" : "true",
"tag" : ["核心属性", "用户自定义属性"],
"description" : "这是一个属性描述"
}

查询资源模型属性列表


- 测试关键字


get attribute list in object

- 接口访问URL


GET /object/@object_id/attr

- 参数




















名称 类型 必选 备注 默认值
object_id string 资源模型ID

- 返回值说明



返回类型: json

资源模型属性列表



- 返回码















返回码 备注
130300 数据库错误

获取资源模型属性


- 测试关键字


get attribute in object

- 接口访问URL


GET /object/@object_id/attr/@attr_id

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
attr_id string 属性ID

- 返回值说明



返回类型: json

资源模型属性



删除资源模型属性


- 测试关键字


delete attribute in object

- 接口访问URL


DELETE /object/@object_id/attr/@attr_id

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
attr_id string 属性ID

- 返回值说明



返回类型: json

null



- 返回码























返回码 备注
130300 数据库错误
130602 核心属性不允许删除
133212 属性不存在

修改资源模型属性


- 测试关键字


modify attribute in object

- 接口访问URL


PUT /object/@object_id/attr/@attr_id

- 参数
















































































名称 类型 必选 备注 默认值
object_id string 资源模型ID
attr_id string 属性ID
name string 属性名称
value array 值类型声明
view array 外键的值在实例详情页面显示的字段
unique bool 是否唯一
required bool 是否必填
readonly bool 是否只读
tag array 标签
tips string 在实例输入框中的提示消息
description string 外键关系属性描述

- 返回值说明



返回类型: json

null



- 返回码























返回码 备注
130300 数据库错误
130310 创建唯一索引失败
133212 属性不存在

- 请求示例


PUT /object/APP/attr/my_first_id
{
"name" : "我新建的一个ID",
"value" : {
"type" : "str",
"regex" : "",
"default" : "guid()",
"default_type" : "function"
},
"unique" : "true",
"required" : "true",
"readonly" : "true",
"tag" : ["核心属性", "用户自定义属性"],
"description" : "这是一个属性描述"
}

查询剩余可自定义对象数量


- 测试关键字


get custom object limit remain

- 接口访问URL


GET /object/_limit

- 返回值说明



返回类型: json

自定义对象数量限制信息



- 返回码















返回码 备注
130300 数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"remain": null,
"total": 33,
"limit": null
},
"error": "\u6210\u529f"
}

查询图标和模型对应关系


- 接口访问URL


GET /all_object_icon

- 返回值说明



返回类型: json

图标和id的对应关系数据



- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"APP": "icon-1",
"HOST": ""
},
"error": "\u6210\u529f"
}

新建实例手动审计日志记录


- 测试关键字


insert instance manual audit log

- 接口访问URL


POST /object/@object_id/instance/_manual_audit

- 参数












































名称 类型 必选 备注 默认值
object_id string 资源模型ID
mark_memo string 标记备注
instance_id_url array 实例id对应URL列表
email_user_id array 通知用户Id列表
email_group_id array 通知用户组Id列表

- 返回值说明



返回类型: json

json



- 请求示例


POST /object/APP/instance/_manual_audit
{
"mark_memo": "应用备注不明确",
"instance_id_url": {
"536363526": "http://192.168.0.67/object/APP/instance/536372727",
"536363524": "http://192.168.0.67/object/APP/instance/536372724"
},
"email_user_id": [
"3652263767",
"36363553635"
],
"email_group_id": [
"736363663",
"365363663"
]
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": null,
"error": "\u6210\u529f"
}

新建实例自动巡检审计日志记录


- 测试关键字


insert instance auto audit log

- 接口访问URL


POST /audit/object/instance/_auto_audit

- 参数
































名称 类型 必选 备注 默认值
instance_invalid_fields array 自动巡检实例错误信息
email_user_id array 通知用户Id列表
email_group_id array 通知用户组Id列表

- 返回值说明



返回类型: json

json



- 请求示例


POST /audit/object/instance/_auto_audit
{
"instance_invalid_fields": {
"APP": {
"536363526": {
"url": "http://192.168.0.67/object/APP/instance/536372727",
"invalid_fields": {
"name": "name null",
"memo": "memo null"
}
},
"536363524": {
"url": "http://192.168.0.67/object/APP/instance/536372727",
"invalid_fields": {
"name": "name null",
"memo": "memo null"
}
}
},
"HOST": {
"333333": {
"url": "http://192.168.0.67/object/APP/instance/536372727",
"invalid_fields": {
"name": "name null",
"memo": "memo null"
}
}
}
},
"email_user_id": [
"3652263767",
"36363553635"
],
"email_group_id": [
"736363663",
"365363663"
]
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": null,
"error": "\u6210\u529f"
}

用户组ID列表查询


- 接口访问URL


GET /groups/id

- 参数




















名称 类型 必选 备注 默认值
user_id string 用户id, 传此参数返回用户所在的所有用户组, 默认返回所有用户组

- 返回值说明



返回类型: json

用户组id列表



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET http://cmdb.easyops-only.com/groups/id?user_id=lightjiao

- 返回示例


{
"message": "Success",
"code": 0,
"data": [
":59228ffb4ccdb",
":5943345194b49"
],
"error": "\u6210\u529f"
}

用户组ID名称映射列表查询


- 接口访问URL


GET /groups/id_map_name

- 参数




















名称 类型 必选 备注 默认值
user_id string 用户id, 传此参数返回用户所在的所有用户组, 默认返回所有用户组

- 返回值说明



返回类型: json

用户组id名称映射列表



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET http://cmdb.easyops-only.com/groups/id_map_name?user_id=lightjiao

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": [
":59228ffb4ccdb": "运维组",
":5943345194b49": "CMDB"
]
}

全文搜索接口



指定单个资源模型做全文搜索



- 测试关键字


fulltext search of objectId

- 接口访问URL


GET /fulltext/@objectId/_search

- 参数






































名称 类型 必选 备注 默认值
objectId string 对象ID
keyword string 搜索关键字
page string 页码
pageSize string 页大小

- 返回值说明



返回类型: json

搜索结果及统计结果



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET /fulltext/APP/_search?count=true

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": {
"total": 1,
"page": 1,
"pageSize": 30,
"list": [#实例列表#],
"count": {
"APP": 1
}
}
}

全文搜索接口



真·全文搜索



- 测试关键字


fulltext search

- 接口访问URL


GET /fulltext/_search

- 参数
































名称 类型 必选 备注 默认值
keyword string 搜索关键字
page string 页码
pageSize string 页大小

- 返回值说明



返回类型: json

搜索结果及统计结果



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET /fulltext/_search?count=true

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": {
"total": 4,
"page": 1,
"pageSize": 30,
"list": [#实例列表#],
"count": {
"BUSINESS": 3,
"APP": 1
}
}
}

单个实例查询接口


- 测试关键字


get instance

- 接口访问URL


GET /object/@object_id/instance/@instance_id

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
instance_id string 实例ID

- 返回值说明



返回类型: json

单个实例数据



- 返回码























返回码 备注
130600 权限错误
133116 数据不存在
130300 数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"ctime": "2016-12-26 15:35:15",
"creator": "steve15",
"instanceId": "5860c8333c0f0",
"_ts": 1482737715,
"_version": 1,
"businesses": {
"instanceId": "56e92c9c30164",
"parentId": null,
"name": "TEST",
"businessId": "87dae4d207972ad0d586e1f2e01d63c6",
"level": null
},
"org": 8888,
"name": "indexTest"
},
"error": "\u6210\u529f"
}

分页查询实例


- 测试关键字


get instance page

- 接口访问URL


GET /object/@object_id/instance

- 参数


































名称 类型 必选 备注 默认值
object_id string 资源模型ID
page int 页码 1
page_size int 页大小 30

- 返回值说明



返回类型: json

分页实例数据



- 返回码



















返回码 备注
130600 权限错误
130300 数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"total": 10,
"list": [
{
"ctime": "2016-12-26 15:35:15",
"creator": "steve15",
"instanceId": "5860c8333c0f0",
"_ts": 1482737715,
"_version": 1,
"businesses": {
"instanceId": "56e92c9c30164",
"parentId": null,
"name": "TEST",
"businessId": "87dae4d207972ad0d586e1f2e01d63c6",
"level": null
},
"org": 8888,
"name": "indexTest"
},
{},
{}
],
"page": 1,
"page_size": 30
},
"error": "\u6210\u529f"
}

分页查询归档实例


- 测试关键字


get archive instance page

- 接口访问URL


GET /object/@object_id/instance/_archive

- 参数
































名称 类型 必选 备注 默认值
object_id string 资源模型ID
page int 页码, 默认1
page_size int 页大小, 默认30

- 返回值说明



返回类型: json

分页归档实例数据



- 返回码



















返回码 备注
130600 权限错误
130300 数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"total": 10,
"list": [
{
"ctime": "2016-12-26 15:35:15",
"creator": "steve15",
"instanceId": "5860c8333c0f0",
"_ts": 1482737715,
"_version": 1,
"businesses": {
"instanceId": "56e92c9c30164",
"parentId": null,
"name": "TEST",
"businessId": "87dae4d207972ad0d586e1f2e01d63c6",
"level": null
},
"org": 8888,
"name": "indexTest"
},
{},
{}
],
"page": 1,
"page_size": 30
},
"error": "\u6210\u529f"
}

归档实例


- 测试关键字


archive instance

- 接口访问URL


POST /object/@object_id/instance/@instance_id/_archive

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
instance_id string 实例ID

- 返回值说明



返回类型: json

null



- 返回码



























返回码 备注
130300 数据库错误
130116 实例不存在
133119 实例归档失败
130600 权限错误

- 返回示例


{
"message": "xxx",
"code": 0,
"data": null,
"error": "xxx"
}

激活实例


- 测试关键字


active instance

- 接口访问URL


POST /object/@object_id/instance/@instance_id/_active

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
instance_id string 实例ID

- 返回值说明



返回类型: json

null



- 返回码



























返回码 备注
130300 数据库错误
130116 实例不存在
133120 实例激活失败
130600 权限错误

- 返回示例


{
"message": "xxx",
"code": 0,
"data": null,
"error": "xxx"
}

实例搜索接口



实例数据高级查询接口, query字段的内容对应的是MongoDB的find语法



- 测试关键字


search instances

- 接口访问URL


POST /object/@object_id/instance/_search

- 参数


























































名称 类型 必选 备注 默认值
object_id string 资源模型ID
query array 查询条件
page int 页码, 默认1 1
page_size int 页大小, 默认30 30
fields array 过滤字段, 留空代表返回所有字段
sort array 按字段排序, 留空代表不排序
permission array 按照权限过滤

- 返回值说明



返回类型: json

被搜索实例数据



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例


{
"sort": {
"instanceId": 1
},
"permission": [
"operate",
"update"
],
"fields": {
"instanceId": true,
"ip": true,
"_id": false,
"name": true
},
"page_size": 100,
"query": {
"ip": {
"regex": "light"
}
},
"page": 1
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"total": 1,
"list": [
{
"instanceId": "56e7cca0b1b80",
"ip": "192.168.100.162"
}
],
"page": 1,
"page_size": 30
},
"error": "\u6210\u529f"
}

引用实例反向查询接口


- 测试关键字


search instance ref

- 接口访问URL


GET /object/@object_id/instance/_ref

- 参数














































名称 类型 必选 备注 默认值
object_id string 资源模型ID
ref_object string 引用对象id
ref_instance string 引用实例id
page int 页码, 默认1 1
page_size int 页大小, 默认30 30

- 返回值说明



返回类型: json

引用了指定实例的所有实例数据



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"total": 10,
"list": [
{
"ctime": "2016-12-26 15:35:15",
"creator": "steve15",
"instanceId": "5860c8333c0f0",
"_ts": 1482737715,
"_version": 1,
"businesses": {
"instanceId": "56e92c9c30164",
"parentId": null,
"name": "TEST",
"businessId": "87dae4d207972ad0d586e1f2e01d63c6",
"level": null
},
"org": 8888,
"name": "indexTest"
},
{},
{}
],
"page": 1,
"page_size": 30
},
"error": "\u6210\u529f"
}

查询单个实例约束接口


- 测试关键字


get instance constraints

- 接口访问URL


GET /object/@object_id/instance/@instance_id/_constraints

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
instance_id string 实例ID

- 返回值说明



返回类型: json

约束的对象数组



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": [
{
"object_name": "\u96c6\u7fa4\u7ba1\u7406",
"total": 4,
"object_id": "CLUSTER"
}
],
"error": "\u6210\u529f"
}

业务创建接口



业务创建使用的是通用实例创建接口但是参数比较特殊,所以单独一个doc声明



- 测试关键字


create business

- 接口访问URL


POST /object/BUSINESS/instance

- 参数


























名称 类型 必选 备注 默认值
name string 业务名称
owner array 负责人(Fks)

- 返回值说明



返回类型: json

新创建的业务数据



- 返回码























返回码 备注
130300 数据库错误
130600 权限错误
130313 数据重复

主机创建接口



主机创建使用的是通用实例创建接口但是参数比较特殊,所以单独一个doc声明



- 测试关键字


create host

- 接口访问URL


POST /object/HOST/instance

- 参数
































名称 类型 必选 备注 默认值
hostname string 主机名称
ip string 主机IP (要符合IP正则)
status string 运营状态 (枚举: 运营中; 故障中; 未上线; 下线隔离中; 开发机; 测试机; 维修中; 报废)

- 返回值说明



返回类型: json

新创建的主机数据



- 返回码























返回码 备注
130300 数据库错误
130600 权限错误
130313 数据重复

单个实例创建接口



参数对应具体的资源模型



- 测试关键字


create instance

- 接口访问URL


POST /object/@object_id/instance

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
name string 实例名称

- 返回值说明



返回类型: json

新创建的实例数据



- 返回码























返回码 备注
130300 数据库错误
130600 权限错误
130313 数据重复

- 请求示例


{
"_manager": [],
"name": "indexTest",
"_manager_group": [],
"enum": null,
"businesses": {
"instanceId": "56e92c9c30164"
},
"time": null,
"owner": [
{
"instanceId": "57b434115412e"
},
{
"instanceId": "56dfea1bc8a96"
}
],
"_visitor_group": [],
"_visitor": []
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"_manager": [],
"ctime": "2016-12-26 15:35:15",
"_manager_group": [],
"creator": "steve15",
"instanceId": "5860c8333c0f0",
"_ts": 1482737715,
"_version": 1,
"businesses": {
"instanceId": "56e92c9c30164",
"parentId": null,
"name": "TEST",
"businessId": "87dae4d207972ad0d586e1f2e01d63c6",
"level": null
},
"_visitor_group": [],
"owner": [
{
"instanceId": "57b434115412e",
"user_tel": "18503050129",
"name": "indexzhuo",
"user_email": "[email protected]"
},
{
"instanceId": "56dfea1bc8a96",
"user_tel": null,
"name": "linuschen",
"user_email": "[email protected]"
}
],
"org": 8888,
"_visitor": [],
"name": "indexTest"
},
"error": "\u6210\u529f"
}

单个实例修改接口



参数对应具体的资源模型



- 测试关键字


modify instance

- 接口访问URL


PUT /object/@object_id/instance/@instance_id

- 参数
































名称 类型 必选 备注 默认值
object_id string 资源模型ID
instance_id string 实例ID
name string 实例名称

- 返回值说明



返回类型: json

修改后的实例数据



- 返回码























返回码 备注
130300 数据库错误
130600 权限错误
130313 数据重复

- 请求示例


{
"_visitor_group": [],
"_visitor": [],
"businesses": {
"instanceId": "56e92c9c30164"
},
"_manager": [],
"_manager_group": []
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"_manager": [],
"ctime": "2016-12-26 15:35:15",
"_manager_group": [],
"creator": "steve15",
"instanceId": "5860c8333c0f0",
"_ts": 1482737715,
"_version": 1,
"businesses": {
"instanceId": "56e92c9c30164",
"parentId": null,
"name": "TEST",
"businessId": "87dae4d207972ad0d586e1f2e01d63c6",
"level": null
},
"_visitor_group": [],
"org": 8888,
"_visitor": [],
"name": "indexTest"
},
"error": "\u6210\u529f"
}

单个实例删除接口


- 测试关键字


delete instance

- 接口访问URL


DELETE /object/@object_id/instance/@instance_id

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
instance_id string 实例ID

- 返回值说明



返回类型: json

null; 如果由于实例约束原因导致删除失败, 返回约束该实例的对象id



- 返回码























返回码 备注
130300 数据库错误
130600 权限错误
133117 外键关联错误

获取实例变更日志


- 测试关键字


get instance log

- 接口访问URL


GET /object/@object_id/instance/@instance_id/_logs

- 参数








































名称 类型 必选 备注 默认值
object_id string 资源模型ID
instance_id string 实例ID
page int 页码, 默认1 1
page_size int 页大小, 默认30 30

- 返回值说明



返回类型: json

实例变更历史



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET /object/APP/instance/588071b97e9da/_logs
{
"page": 1,
"page_size": 1000,
"month": "201705"
}

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"data": [
{
"instanceId": "588071b97e9da",
"_object_id": "lightTest",
"difference": [
{ "attr": "name", "op": "update", "from": "rose_1", "to": "rose_2" },
{ "attr": "modifier", "op": "add", "to": "lights" }
],
"databaseOperations": "update"
"user": "lights"
},
{
"instanceId": "588071b97e9da",
"_object_id": "lightTest",
"user": "lights",
"databaseOperations": "insert"
}
]
}

数据导入接口


- 测试关键字


import instances

- 接口访问URL


POST /object/@object_id/instance/_import

- 参数
































名称 类型 必选 备注 默认值
object_id string 资源模型ID
keys array 导入的key
datas array 实例数组

- 返回值说明



返回类型: json

数据导入结果



- 返回码















返回码 备注
133121 实例导入失败

- 请求示例


{
"keys" : ['name'],
"datas" : [
{"name" : "jack", "socre" : 100, "randString" : "adhasjkdfghasjkdfhas"},
{"name" : "rose", "socre" : 90, "randString" : "adhasjkdfghasjkdfhas"}
]
}

- 返回示例


{
"code" : 133121,
"error" : "实例导入失败",
"message" : null,
"data" : [
"failed_count" : 4,
"insert_count" : 0,
"update_count" : 10,
"data" : [
{
"code" : 130313,
"error" : "重复键错误",
"data" : [
{"name" : "jack", "socre" : 100, "randString" : "adhasjkdfghasjkdfhas"}
]
},
{
"code" : 130300,
"error" : "默认数据库错误",
"data" : [
{"name" : "rose", "socre" : 90, "randString" : "adhasjkdfghasjkdfhas"}
]
}
]
]
}

批量编辑接口


- 测试关键字


modify instances

- 接口访问URL


PUT /object/@object_id/instance/_batch_modify

- 参数


























名称 类型 必选 备注 默认值
object_id string 资源模型ID
instances struct 实例列表

- 返回值说明



返回类型: json

null



- 返回码



















返回码 备注
130300 数据库错误
130600 权限错误

- 请求示例


[
{"instanceId" : "balabalabalaba1", "modify_field" : "new value"},
{"instanceId" : "balabalabalaba2", "modify_field" : "new value"},
]

获取实例默认值



根据模型定义获取实例默认值提供给前端填充表单用



- 测试关键字


get instance default value template

- 接口访问URL


GET /object/@object_id/instance/_default_value_template

- 参数




















名称 类型 必选 备注 默认值
object_id string 资源模型ID

- 返回值说明



返回类型: json

null



- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"default_os": "linux",
"uuid": "cc49c1e317ee95362a5c6fd31bbcc2e1"
},
"error": "\u6210\u529f"
}

处理实例修改后动作



实例修改后, 刷新相关联的冗余数据等操作



- 测试关键字


process instance modify

- 接口访问URL


POST /notification/instance_modify_log

- 参数




















名称 类型 必选 备注 默认值
data array 实例数据

- 返回值说明



返回类型: json

null



- 返回码















返回码 备注
130300 数据库错误

实时同步全文搜索数据


- 测试关键字


process instance fulltext index

- 接口访问URL


POST /notification/instance_fulltext_index

- 参数


























名称 类型 必选 备注 默认值
data array 实例数据
topic string 数据变更行为

- 返回值说明



返回类型: json

null



- 返回码















返回码 备注
130300 数据库错误

刷新冗余数据


- 测试关键字


process instance refresh task

- 接口访问URL


POST /notification/instance_refresh_task

- 参数




















名称 类型 必选 备注 默认值
data array 实例数据

- 返回值说明



返回类型: json

null



- 返回码















返回码 备注
130300 数据库错误

查询业务列表



@deprecated, 接口较老,已弃用

高级查询请使用接口POST /object/@object_id/instance/_search



- 接口访问URL


GET /business/search

- 参数






































名称 类型 必选 备注 默认值
name string 业务名称
businessId string 业务ID
parentId string 父ID
order string 排序字段

- 返回值说明



返回类型: json

array 业务列表



查询业务关联链路



deprecated parentID不存在



- 测试关键字


get business link

- 接口访问URL


GET /business/search-link

- 参数




















名称 类型 必选 备注 默认值
parentId string 业务id

- 返回值说明



返回类型: json

关联链路列表



根据一级业务id遍历查询子业务下的所有应用



我现在根据一级业务id获取所有子业务的应用列表,得遍历整棵"一级业务树",效率可能不高...

由于我们现在限制了层数,我可以最多只遍历三层,但是一旦把业务层级限制放开,就复杂些了,现在就做得通用些?



- 测试关键字


get app by businessid

- 接口访问URL


GET /business/appList/@businessId

- 参数




















名称 类型 必选 备注 默认值
businessId string 业务ID

- 返回值说明



返回类型: json

应用列表



查询某个业务的信息



deprecated parentID不存在



- 测试关键字


get business info

- 接口访问URL


GET /business/@businessId

- 参数




















名称 类型 必选 备注 默认值
businessId string 业务ID

- 返回值说明



返回类型: json

业务信息



查询子业务信息


- 测试关键字


get businesses children

- 接口访问URL


GET /business/children/@businessId

- 参数




















名称 类型 必选 备注 默认值
businessId string 业务ID

- 返回值说明



返回类型: json

业务信息



查询业务信息



根据key value 查询业务信息



- 测试关键字


get business by key value

- 接口访问URL


GET /v2/business/@key/@val

- 参数


























名称 类型 必选 备注 默认值
key string
val string

- 返回值说明



返回类型: json

应用信息



获取用户配置信息namespace


- 接口访问URL


GET /user/profile/@namespace

- 返回值说明



返回类型: json

返回用户配置信息namespace



- 返回码



















返回码 备注
130300 数据库错误
130308 查询无结果

获取用户配置信息值


- 接口访问URL


GET /user/profile/@namespace/@key

- 返回值说明



返回类型: json

返回用户配置信息值



- 返回码



















返回码 备注
130300 数据库错误
130308 查询无结果

修改用户配置信息值


- 接口访问URL


PUT /user/profile/@namespace/@key

- 参数
































名称 类型 必选 备注 默认值
namespace string 用户配置命名空间
key string 用户配置项
value mix 用户配置数据

- 返回码



















返回码 备注
130300 数据库错误
130305 数据库更新错误

获取资源模型下某一属性的值


- 测试关键字


get attribute value in object

- 接口访问URL


GET /object/instance/attr/@objectId/@attrId

- 参数














































名称 类型 必选 备注 默认值
objectId string 资源模型ID
attrId string 属性ID
sort int 排序
page int 页码 1
pagrSize int 页大小 30

- 返回值说明



返回类型: json

某一属性的所有值



- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"total": 70,
"list": [
"\u751f\u4ea7\u96c6\u7fa41",
"\u6d4b\u8bd5\u96c6\u7fa41",
"\u9884\u53d1\u5e03\u96c6\u7fa4",
"\u9ec4\u4ec1\u7684\u96c6\u7fa4",
"\u7070\u5ea6\u96c6\u7fa4"
],
"page": 1,
"pageSize": 30
},
"error": "\u6210\u529f"
}

更新冗余数据



@deprecated 实例数据中不包含objectId、instanceId或者org被视为非法数据直接消费



- 接口访问URL


POST /object/instance/message

- 参数




















名称 类型 必选 备注 默认值
data array 实例数据,

- 返回值说明



返回类型: json

null



多实例查询



url中包含查询对象的ID,body中包含需要查询的实例ID



- 测试关键字


get instance list by instanceids for export

- 接口访问URL


POST /object/@objectId/instances/_export

- 参数








































名称 类型 必选 备注 默认值
objectId string 查询的对象ID
instanceIds array 实例Id列表
page int 页码 1
pagrSize int 页大小 30

- 返回值说明



返回类型: json

实例列表



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


{
"instanceIds":['123', '456']
}

- 返回示例


{
"code": 0,
"error": "成功",
"message": "Success",
"list": [
{'instanceField_1': 'value_1', instanceField_2: 'value_2'},
{'instanceField_1': 'value_3', instanceField_2: 'value_4'}
]
}

个人信息查询


- 测试关键字


get my profile

- 接口访问URL


GET /profile

- 返回值说明



返回类型: json

个人信息



- 返回码















返回码 备注
130300 数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"modifier": "admin",
"user_tel": null,
"name": "lights",
"creator": "admin",
"instanceId": "5875f71840da5",
"org": 8888,
"user_type": null,
"phone": null,
"state": "valid",
"user_memo": null,
"mtime": "2016-03-28 12:42:02",
"user_active": "\u6fc0\u6d3b",
"_id": {},
"email": "[email protected]",
"user_email": "[email protected]",
"ctime": "2016-03-09 17:17:15"
},
"error": "\u6210\u529f"
}

查询个人apikey


- 测试关键字


get my apikey

- 接口访问URL


GET /profile/apikey

- 返回值说明



返回类型: json

apikey



- 返回码















返回码 备注
130300 数据库错误

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"access_key": "e7b6a060b55b42713332b93c",
"ctime": "2017-03-29 10:11:38",
"ts": 1490753498,
"state": "valid",
"user": "lightjiao11",
"org": 8888,
"secret_key": "f1ede17ef5078a9ef62fa0a113b43a710820257700ff67ae9b6a29eed891ec5a"
},
"error": "\u6210\u529f"
}

修改个人密码


- 测试关键字


modify my password

- 接口访问URL


PUT /profile/password

- 参数


























名称 类型 必选 备注 默认值
password string 旧密码
new_password string 新密码

- 返回值说明



返回类型: json

null



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


{
"new_password": "654321",
"password": "123456"
}

- 返回示例


{
"message": "Success",
"code": 0,
"data": null,
"error": "\u6210\u529f"
}

用户忘记密码



用户忘记密码接口



- 测试关键字


forgot password

- 接口访问URL


POST /password/forgot

- 参数


























名称 类型 必选 备注 默认值
email string 邮件地址
url string 重置密码地址

- 返回值说明



返回类型: json

重置密码信息



- 返回码















返回码 备注
130300 数据库错误

用户重置密码



暂时不做自动化测试,因为自动化测试无法获取到重置密码的验证码



- 接口访问URL


POST /password/reset

- 参数






































名称 类型 必选 备注 默认值
username string 用户名
ts int 时间戳
password string 新密码
key string 重置密码key

- 返回值说明



返回类型: json

重置密码key



- 返回码















返回码 备注
130300 数据库错误

查询应用



@deprecated, 接口较老,已弃用

高级查询请使用接口POST /object/@object_id/instance/_search



- 测试关键字


search app

- 接口访问URL


GET /application/search

- 参数






























































名称 类型 必选 备注 默认值
name string 应用名称
appId string 应用ID
businessId string 业务ID
order string 排序字段
fields string 选择字段
ignore string 忽略字段
page int 分页
pageSize int 分页大小

- 返回值说明



返回类型: json

应用列表



查询应用列表



@deprecated, 接口较老,已弃用

高级查询请使用接口POST /object/@object_id/instance/_search



- 测试关键字


search app list

- 接口访问URL


GET /application/search-all

- 参数












































名称 类型 必选 备注 默认值
name string 应用名称
appId string 应用ID
appIds string 应用ID, 用分号隔开
businessId string 业务ID
order string 排序字段

- 返回值说明



返回类型: json

应用列表



获取应用下的设备以及集群信息数量



自动化测试的keyword不使用自动生成而是自定义编写



- 接口访问URL


GET /applications/extra

- 参数




















名称 类型 必选 备注 默认值
appIds array 应用id列表

- 返回值说明



返回类型: json

获取的信息列表array



- 返回码















返回码 备注
130300 数据库错误

- 请求示例


GET /applications/extra?appIds[0]=56dff11497f66&appIds[1]=56e0dbec4da6f

- 返回示例


{
"message": "Success",
"code": 0,
"data": {
"56e0dbec4da6f": {
"device": 0,
"cluster": 0
},
"56dff11497f66": {
"device": 38,
"cluster": 0
}
},
"error": "\u6210\u529f"
}

批量查询应用信息



根据指定字段以及字段值查询应用

@deprecated, 接口较老,不建议使用

高级查询请使用接口POST /object/@object_id/instance/_search



- 测试关键字


get app by key value

- 接口访问URL


GET /v2/app/@key/@val

- 参数


























名称 类型 必选 备注 默认值
key string
val string

- 返回值说明



返回类型: json

应用信息



- 返回码















返回码 备注
130300 数据库错误

批量获取应用列表



@deprecated, 接口较老,不建议使用

高级查询请使用接口POST /object/@object_id/instance/_search



- 测试关键字


get app list by instanceids

- 接口访问URL


GET /apps/@instanceIds

- 参数


































名称 类型 必选 备注 默认值
instanceIds string 应用id列表,逗号分割,id为空时,获取所有应用列表
page int 当前页码 1
pageSize int 每页大小 30

- 返回值说明



返回类型: json

应用列表



- 返回码















返回码 备注
130300 数据库错误

- 返回示例


{
"message": null,
"code": 0,
"data": {
"total": 78,
"list": [
{
"runUser": null,
"name": "\u5e94\u7528\u529f\u80fd",
"businessId": null,
"installPath": null,
"instanceId": "56e7cd0fe76cf",
"mtime": "2016-04-18 21:43:38",
"memo": null,
"tester": null,
"org": 8888,
"ctime": "2016-03-15 16:51:27",
"businesses": null,
"packageId": null,
"appId": "f12e441dbba9d7acd36212ab4906eaca",
"owner": [
{
"instanceId": "56dfea1c74405",
"name": "davidcui"
}
],
"clusters": [
{
"name": "\u9ed8\u8ba4\u96c6\u7fa4",
"deviceList": [
{
"status": "\u8fd0\u8425\u4e2d",
"instanceId": "56e674a85fe98",
"ip": "192.168.26.22",
"hostname": "192.168.26.22",
"deviceId": "122",
"provider": "1",
"location": "1"
}
],
"clusterId": "e876a01a75196e35a1f8416f405d9719",
"instanceId": "56e7cd1047479",
"packageId": null,
"type": 2
}
],
"modifier": "indexzhuo",
"creator": "davidcui",
"developer": null
}
]
},
"error": "\u6210\u529f"
}

搜索应用列表



@deprecated, 接口较老,不建议使用

高级查询请使用接口POST /object/@object_id/instance/_search



- 测试关键字


search apps by key value

- 接口访问URL


GET /apps/@key/@val

- 参数






































名称 类型 必选 备注 默认值
key string 搜索的应用属性
val string 搜索的应用属性值
page int 当前页码
pageSize int 每页大小

- 返回值说明



返回类型: json

应用列表



- 返回码















返回码 备注
130300 数据库错误




你可能感兴趣的:(无标题文章)