新加自定义API接口

  • API: POST /api/{version}/userapi
  • API名称: create_custom_query
  • 功能说明:

    • 中文: 添加自定义api
    • English :create customize query
  • input body:

    1. {
    2. "bk_biz_id":12,
    3. "info":"{\"condition\":[{\"bk_obj_id\":\"biz\",\"condition\":[{\"field\":\"default\",\"operator\":\"$ne\",\"value\":1}],\"fields\":[]},{\"bk_obj_id\":\"set\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"module\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"host\",\"condition\":[{\"field\":\"bk_host_innerip\",\"operator\":\"$eq\",\"value\":\"127.0.0.1\"}],\"fields\":[\"bk_host_innerip\",\"bk_host_outerip\",\"bk_agent_status\"]}]}",
    4. "name":"api1"
    5. }
  • input参数说明

名称 类型 必填 默认值 说明 Description
bk_biz_id int 业务ID business ID
info json string 通用查询条件 common search query parameters
name string 收藏的名称 the name of user api

info 参数说明:

名称 类型 必填 默认值 说明 Description
bk_obj_id string 对象名,可以为biz,set,module,host,object object name, it can be biz,set,module,host,object
fields string数组 查询输出字段 fields output
condition object array 查询条件 search condition

二级condition 参数说明:

名称 类型 必填 默认值 说明 Description
field string 对象的字段 field of object
operator string 操作符, $eq为相等,$neq为不等,$in为属于,$nin为不属于 $eq is equal,$in is belongs, $nin is not belong,$neq is not equal
value string 字段对应的值 the value of field
  • output
  1. {
  2. "result":true,
  3. "bk_error_code":0,
  4. "bk_error_msg":"",
  5. "data":{
  6. "id":"b80nu3dmjrccd9i5r1eg"
  7. }
  8. }
  • output字段说明
名称 类型 说明 Description
id string 自定义api主键ID Primary key ID

更新自定义API接口

  • API: PUT /api/{version}/userapi/{bk_biz_id}/{id}

  • API名称: update_custom_query

  • 功能说明:

    • 中文:更新自定义api
    • English :update customize query
  • input body:

    1. {
    2. "info":"{\"condition\":[{\"bk_obj_id\":\"biz\",\"condition\":[{\"field\":\"default\",\"operator\":\"$ne\",\"value\":1}],\"fields\":[]},{\"bk_obj_id\":\"set\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"module\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"host\",\"condition\":[{\"field\":\"bk_host_innerip\",\"operator\":\"$eq\",\"value\":\"127.0.0.1\"}],\"fields\":[\"bk_host_innerip\",\"bk_host_outerip\",\"bk_agent_status\"]}]}",
    3. "name":"api1"
    4. }
  • input参数说明
名称 类型 必填 默认值 说明 Description
bk_biz_id int 业务ID business ID
id string 主键ID Primary key ID
info json string 通用查询条件 common search query parameters
name string 收藏的名称 the name of user api

info 参数说明:

名称 类型 必填 默认值 说明 Description
bk_obj_id string 对象名,可以为biz,set,module,host,object object name, it can be biz,set,module,host,object
fields string数组 查询输出字段 fields output
condition object array 查询条件 search condition

condition 参数说明:

名称 类型 必填 默认值 说明 Description
field string 对象的字段 field of object
operator string 操作符, $eq为相等,$neq为不等,$in为属于,$nin为不属于 $eq is equal,$in is belongs, $nin is not belong,$neq is not equal
value string 字段对应的值 the value of field
  • output
    1. {
    2. "result":true,
    3. "bk_error_code":0,
    4. "bk_error_msg":"",
    5. "data":null
    6. }
  • output 参数说明:
名称 类型 说明 Description
result bool 请求成功与否。true:请求成功;false请求失败 request result
bk_error_code int 错误编码。 0表示success,>0表示失败错误 error code. 0 represent success, >0 represent failure code
bk_error_msg string 请求失败返回的错误信息 error message from failed request
data null 请求返回的数据 return data

删除自定义API接口

  • API: DELETE /api/{version}/userapi/{bk_biz_id}/{id}

  • API名称: delete_custom_query

  • 功能说明:
    • 中文: 删除自定义api
    • English :delete customize query
  • input body

  • input参数说明

名称 类型 必填 默认值 说明 Description
bk_biz_id int 业务ID business ID
id string 主键ID Primary key ID
  • output
  1. {
  2. "result":true,
  3. "bk_error_code":0,
  4. "bk_error_msg":"",
  5. "data":null
  6. }
  • output 参数说明:
名称 类型 说明 Description
result bool 请求成功与否。true:请求成功;false请求失败 request result
bk_error_code int 错误编码。 0表示success,>0表示失败错误 error code. 0 represent success, >0 represent failure code
bk_error_msg string 请求失败返回的错误信息 error message from failed request
data null 请求返回的数据 return data

查询自定义API

  • API: POST /api/{version}/userapi/search/{bk_biz_id}
  • API名称: search_custom_query
  • 功能说明:
    • 中文: 查询自定义api
    • English :search customize query
  • input body
  1. {
  2. "condition":{
  3. "name": "aa",
  4. },
  5. "start": 0,
  6. "limit": 20,
  7. }
  • input参数说明
名称 类型 必填 默认值 说明 Description
bk_biz_id int 业务ID business ID
condition object对象 查询条件 search condition
start int 记录开始位置 start record
limit int 每页限制条数,最大200 page limit, max is 200

condition 参数说明: condition 字段为自定义api的属性字段, 可以是create_user,modify_user, name

  • ouput

    1. {
    2. "result":true,
    3. "bk_error_code":0,
    4. "bk_error_msg":null,
    5. "data":{
    6. "count":1,
    7. "info":[
    8. {
    9. "bk_biz_id":12,
    10. "create_time":"2018-03-02T15:04:20.117+08:00",
    11. "create_user":"admin_default",
    12. "id":"bacfet4kd42325venmcg",
    13. "info":"{\"condition\":[{\"bk_obj_id\":\"biz\",\"condition\":[{\"field\":\"default\",\"operator\":\"$ne\",\"value\":1}],\"fields\":[]},{\"bk_obj_id\":\"set\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"module\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"host\",\"condition\":[{\"field\":\"bk_host_innerip\",\"operator\":\"$eq\",\"value\":\"127.0.0.1\"}],\"fields\":[\"bk_host_innerip\",\"bk_host_outerip\",\"bk_agent_status\"]}]}",
    14. "last_time":"",
    15. "modify_user":"",
    16. "name":"api1"
    17. }
    18. ]
    19. }
    20. }
  • output字段说明:

名称 类型 说明 Description
result bool 请求成功与否。true:请求成功;false请求失败 request result
bk_error_code int 错误编码。 0表示success,>0表示失败错误 error code. 0 represent success, >0 represent failure code
bk_error_msg string 请求失败返回的错误信息 error message from failed request
data object 请求返回的数据 return data

data字段说明:

名称 类型 说明 Description
count int 记录条数 count of record
info object array 自定义api数据 detail of record

info 字段说明:

名称 类型 说明 Description
bk_biz_id int 业务ID business ID
create_time 时间格式 创建时间 create time
create_user string 创建者 create user
id string 自定义api主键ID primary key ID
info json string 自定义api信息 the query info
last_time string 更新时间 last update time
modify_user string 修改者 modify user
name string 自定义api命名 the name of api

info 参数说明:

名称 类型 必填 默认值 说明 Description
bk_obj_id string 对象名,可以为biz,set,module,host,object object name, it can be biz,set,module,host,object
fields string数组 查询输出字段 fields output
condition object array 查询条件 search condition

condition 参数说明:

名称 类型 必填 默认值 说明 Description
field string 对象的字段 field of object
operator string 操作符, $eq为相等,$neq为不等,$in为属于,$nin为不属于 $eq is equal,$in is belongs, $nin is not belong,$neq is not equal
value string 字段对应的值 the value of field

获取自定义API详情

  • API: GET /api/{version}/userapi/detail/{bk_biz_id}/{id}
  • API名称: get_custom_query_detail
  • 功能说明:
    • 中文: 获取自定义api详情
    • English :get customize query detail
  • input body

  • input参数说明

名称 类型 必填 默认值 说明 Description
bk_biz_id int 业务ID business ID
id string 主键ID pripary key ID
  • ouput
  1. {
  2. "result":true,
  3. "bk_error_code":0,
  4. "bk_error_msg":null,
  5. "data":{
  6. "biz_id":12,
  7. "creat_time":"2018-03-02T15:04:20.117+08:00",
  8. "create_user":"admin_default",
  9. "id":"bacfet4kd42325venmcg",
  10. "info":"{\"condition\":[{\"bk_obj_id\":\"biz\",\"condition\":[{\"field\":\"default\",\"operator\":\"$ne\",\"value\":1}],\"fields\":[]},{\"bk_obj_id\":\"set\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"module\",\"condition\":[],\"fields\":[]},{\"bk_obj_id\":\"host\",\"condition\":[{\"field\":\"bk_host_innerip\",\"operator\":\"$eq\",\"value\":\"127.0.0.1\"}],\"fields\":[\"bk_host_innerip\",\"bk_host_outerip\",\"bk_agent_status\"]}]}",
  11. "last_time":"",
  12. "modify_user":"",
  13. "name":"api1"
  14. }
  15. }
  • output字段说明
名称 类型 说明 Description
result bool 请求成功与否。true:请求成功;false请求失败 request result
bk_error_code int 错误编码。 0表示success,>0表示失败错误 error code. 0 represent success, >0 represent failure code
bk_error_msg string 请求失败返回的错误信息 error message from failed request
data object 请求返回的数据 return data

data字段说明:

名称 类型 说明 Description
bk_biz_id int 业务ID business ID
create_time 时间格式 创建时间 create time
create_user string 创建者 create user
id string 自定义api主键ID primary key ID
info json string 自定义api信息 the query info
last_time string 更新时间 last update time
modify_user string 修改者 modify user
name string 自定义api命名 the name of api

info 参数说明:

名称 类型 说明 Description
bk_obj_id string 对象名,可以为biz,set,module,host,object object name, it can be biz,set,module,host,object
fields string数组 查询输出字段 fields output
condition object array 查询条件 search condition

condition 参数说明:

名称 类型 说明 Description
field string 对象的字段 field of object
operator string 操作符, $eq为相等,$neq为不等,$in为属于,$nin为不属于 $eq is equal,$in is belongs, $nin is not belong,$neq is not equal
value string 字段对应的值 the value of field

根据自定义api获取数据

  • API:
    GET /api/{version}/userapi/data/{bk_biz_id}/{id}/{start}/{limit}
  • API名称: get_custom_query_data
  • 功能说明:
    • 中文: 根据自定义api获取数据
    • English :get customize query data
  • input body
  • input参数说明
名称 类型 必填 默认值 说明 Description
bk_biz_id int 业务ID business ID
id string 主键ID primary key ID
start int 记录开始位置 start record
limit int 每页限制条数,最大200 page limit, max is 200
  • output
  1. {
  2. "result":true,
  3. "bk_error_code":0,
  4. "bk_error_msg":null,
  5. "data":{
  6. "count":1,
  7. "info":[
  8. {
  9. "biz":{
  10. "bk_biz_id":11,
  11. "bk_biz_name":"1111",
  12. "create_time":"2017-12-20T14:45:22.04+08:00",
  13. "default":0,
  14. "last_time":"2017-12-20T14:45:22.04+08:00",
  15. "bk_biz_maintainer":"tt",
  16. "bk_supplier_account":"0",
  17. "bk_biz_productor":"tt",
  18. "dg":""
  19. },
  20. "host":{
  21. "bk_host_assetid":"",
  22. "bk_comment":"准备下架设备",
  23. "create_time":"2018-01-04T14:41:17.376+08:00",
  24. "bk_host_id":187,
  25. "bk_host_name":"nginx.27",
  26. "bk_host_type":"虚拟机",
  27. "import_from":"1",
  28. "bk_host_innerip":"10.0.0.0",
  29. "bk_cloud_id":0,
  30. "aaa":"",
  31. "cpu":"",
  32. "enum2":""
  33. },
  34. "module":{
  35. "bk_module_name":"空闲机"
  36. },
  37. "set":{
  38. "bk_set_name":"内置模块集"
  39. }
  40. }
  41. ]
  42. }
  43. }
  • output字段说明
名称 类型 说明 Description
result bool 请求成功与否。true:请求成功;false请求失败 request result
bk_error_code int 错误编码。 0表示success,>0表示失败错误 error code. 0 represent success, >0 represent failure code
bk_error_msg string 请求失败返回的错误信息 error message from failed request
data object 请求返回的数据 return data

data 字段说明:

名称 类型 说明 Description
count int 记录条数 the num of record
info object array 主机实际数据 host data

info 字段说明:

名称 类型 说明 Description
biz object 主机所属的业务信息 host biz info
set object 主机所属的集群信息 host set info
module object 主机所属的模块信息 host module info
host object 主机自身属性 host attr info