• 新增主机
  • 主机转移到业务内模块
  • 资源池主机分配至业务的空闲机模块
  • 主机上交至业务的故障机模块
  • 主机上交至业务的空闲机模块
  • 主机回收至资源池
  • 转移主机至模块
  • 清空集群/模块下主机
  • 同步新增主机到业务

    新增主机

    • API: POST /api/{version}/hosts/add
    • API名称： add_host_to_resource
    • 功能说明：
      • 中文：新增主机到资源池
      • English ：add host to resource
    • input body：
      1. {
      2. 　　"host_info":{
      3. 　　　　"0":{
      4. 　　　　　　"bk_host_innerip":"127.0.0.1",
      5. 　　　　　　"import_from":"3",
      6. 　　　　　　"bk_cloud_id":1
      7. 　　　　}
      8. 　　},
      9. 　　"bk_supplier_id":0,
      10. 　　"bk_biz_id":3
      11. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    host_info object array 是 无 主机信息 host info
    bk_supplier_id int 是 无 开发商 ID supplier ID
    bk_biz_id int 否 无 业务ID business ID

    host_info object 说明：

    名称 类型 必填 默认值 说明 Description
    bk_host_innerip string 是 无 主机内网ip host inner ip
    import_from string 是 api 主机导入来源,以api方式导入为3 host import source
    bk_cloud_id int 是 无 云区域ID cloud area 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 true or false
    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 json string 请求返回的数据,示例如下（{“error”:[“6行字段正则校验失败”,”7行字段正则校验失败”],”success”:[“4”,”5”],”update_error”:null}） the data response

    主机转移到业务内模块

    • API: POST /api/{version}/hosts/modules
    • API名称： transfer_host_module
    • 功能说明：
      • 中文：业务内主机转移模块
      • English ：transfer host to module in biz
    • input body：
      1. {
      2.   "bk_biz_id":151,
      3.   "bk_host_id":[
      4.       10,
      5.       9
      6.   ],
      7.   "bk_module_id":[
      8.       170
      9.   ],
      10.   "is_increment":true
      11. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    bk_biz_id int 是 无 业务ID business ID
    bk_host_id int数组 是 无 主机 ID host ID
    bk_module_id int数组 是 无 模块 id module ID
    is_increment bool 是 无 覆盖或者追加,会删除原有关系. true是更新，false是覆盖 cover or pursue ,true will cover

    • 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 true or false
    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 请求返回的数据 the data response

    资源池主机分配至业务的空闲机模块

    • API: POST /api/{version}/hosts/modules/resource/idle
    • API名称： transfer_resourcehost_to_idlemodule
    • 功能说明：
      • 中文： 分配资源池主机到业务的空闲机模块
      • English ：transfer resource host to idle module
    • input body：
      1. {
      2. "bk_biz_id": 115, 
      3. "bk_host_id": [
      4.   10, 
      5.   9
      6. ]
      7. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    bk_biz_id int 是 无 业务ID host ID
    bk_host_id int数组 是 无 主机ID host 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 true or false
    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 请求返回的数据 the data response

    主机上交至业务的故障机模块

    • API: POST /api/{version}/hosts/modules/fault
    • API名称： transfer_host_to_faultmodule
    • 功能说明：
      • 中文： 上交主机到业务的故障机模块
      • English ：transfer host to fault module
    • input body:
      1. {
      2. "bk_biz_id": 115, 
      3. "bk_host_id": [
      4.   10, 
      5.   9
      6. ]
      7. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    bk_biz_id int 是 无 业务id business ID
    bk_host_id int数组 是 无 主机id host 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 true or false
    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 请求返回的数据 the data response

    主机上交至业务的空闲机模块

    • API: POST /api/{version}/hosts/modules/idle
    • API名称： transfer_host_to_idlemodule
    • 功能说明：
      • 中文：上交主机到业务的空闲机模块
      • English ：transfer host to idle module
    • input boy:
      1. {
      2. "bk_biz_id": 115, 
      3. "bk_host_id": [
      4.   10, 
      5.   9
      6. ]
      7. }
    • input字段说明
    名称 类型 必填 默认值 说明 Description
    bk_biz_id int 是 无 业务id business ID
    bk_host_id int数组 是 无 主机id host 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 true or false
    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 请求返回的数据 the data response

    主机回收至资源池

    • API: POST /api/{version}/hosts/modules/resource
    • API名称： transfer_host_to_resourcemodule
    • 功能说明：
      • 中文：上交主机至资源池
      • English ：transfer host to resource module
    • input boy:
    • input:
      1. {
      2. "bk_biz_id":269,
      3. "bk_host_id":[204]
      4. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    bk_biz_id int 是 无 业务id business ID
    bk_host_id int数组 是 无 主机id host ID

    • output:

      1. {
      2.   "result":true,
      3.   "bk_error_code":0,
      4.   "bk_error_msg":null,
      5.   "data":""
      6. }

    • output字段说明

    名称 类型 说明 Description
    result bool 请求成功与否。true:请求成功；false请求失败 request result true or false
    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 请求返回的数据 the data response

    转移主机至模块

    • API: POST /api/{version}/hosts/modules/biz/mutilple
    • API名称： transfer_host_to_mutiple_biz_modules
    • 功能说明：
      • 中文：转移主机至模块，此模块属于不同业务
      • English ：transfer host to module,this module belongs to different business
    • input boy:
    • input:
      1. {
      2.   "bk_biz_id":10,
      3.   "bk_module_id":58,
      4.   "host_info":[
      5.    {
      6.      "bk_host_innerip":"10.20.30.45",
      7.      "bk_cloud_id":0
      8.   }]
      9. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    bk_biz_id int 是 无 业务id business ID
    bk_host_id int array 是 无 主机id host ID
    host_info object array 是 无 主机信息 主机信息数组

    host_info说明：

    名称 类型 必填 默认值 说明 Description
    bk_host_innerip string 是 无 主机内网ip host inner ip
    bk_cloud_id int 是 无 云区域ID cloud area ID

    • output:

      1. {
      2.   "result":true,
      3.   "bk_error_code":0,
      4.   "bk_error_msg":"success",
      5.   "data":"sucess"
      6. }

    • output字段说明

    名称 类型 说明 Description
    result bool 请求成功与否。true:请求成功；false请求失败 request result true or false
    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 请求返回的数据 the data response

    清空集群/模块下主机

    • API: POST /api/{version}/hosts/modules/idle/set
    • API名称： transfer_sethost_to_idle_module
    • 功能说明：
      • 中文：清空业务下集群/模块中主机
      • English ：transfer host in set or module to idle module
    • input boy:
    • input:
      1. {
      2.   "bk_biz_id":10,
      3.   "bk_module_id":58,
      4.   "bk_set_id":1
      5. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    bk_biz_id int 是 无 业务id business ID
    bk_set_id int 是 无 集群id set ID
    bk_module_id int 是 无 模块id module ID

    • output:

      1. {
      2.   "result":true,
      3.   "bk_error_code":0,
      4.   "bk_error_msg":"success",
      5.   "data":"sucess"
      6. }

    • output字段说明

    名称 类型 说明 Description
    result bool 请求成功与否。true:请求成功；false请求失败 request result true or false
    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 请求返回的数据 the data response

    同步新增主机到业务

    • API: POST /api/{version}/hosts/sync/new/host
    • API名称：
    • 功能说明：
      • 中文：同步新增主机到业务
      • English ：add new hosts to the service
    • input body：
      1. {
      2. 　　"host_info":{
      3. 　　　　"0":{
      4. 　　　　　　"bk_host_innerip":"127.0.0.1",
      5. 　　　　　　"bk_cloud_id":1
      6. 　　　　}
      7. 　　},
      8. 　　"bk_biz_id": 3,
      9.   "bk_module_id":[7,8],
      10. }
    • input字段说明:
    名称 类型 必填 默认值 说明 Description
    host_info object array 是 无 主机信息 host info
    bk_biz_id int 是 无 业务 ID bussines ID
    bk_module_id int array 是 无 模块 ID 模块 ID

    host_info object 说明：

    名称 类型 必填 默认值 说明 Description
    bk_host_innerip string 是 无 主机内网ip host inner ip
    bk_cloud_id int 是 无 云区域ID cloud ID
    … 主机其他属性

    • output：

      1. {
      2.   "result": true,
      3.   "bk_error_code": 0,
      4.   "bk_error_msg": "success",
      5.   "data": {
      6.       "success": [
      7.           "4"
      8.       ]
      9.   }
      10. }

    • output字段说明:

    名称 类型 说明 Description
    result bool 请求成功与否。true:请求成功；false请求失败 request result true or false
    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 请求返回的数据 the data response