[TOC]
一、简要描述
二、请求URL
http://10.52.181.25:8080/ops/customize/cmdbScriptApi
三、请求协议
四、请求方式
五、请求头部
- Content-Type :application/json
六、请求参数
1、新增/修改模型
参数
参数名 |
必选 |
类型 |
说明 |
publicClass |
是 |
string |
方法名(新增:addModel/修改:updateModel) |
objectId |
是 |
string |
模型id |
name |
是 |
string |
模型名字 |
参数示例
{
"publicClass": "updateModel",
"objectId": "HOST",
"name": "主机"
}
2、删除模型
参数
参数名 |
必选 |
类型 |
说明 |
publicClass |
是 |
string |
方法名(deleteModel) |
objectId |
是 |
string |
模型id |
参数示例
{
"publicClass": "deleteModel",
"objectId": "HOST"
}
3、新增/修改模型属性
参数
参数名 |
必选 |
类型 |
说明 |
publicClass |
是 |
string |
方法名(新增:addAttribute/修改:updateAttribute) |
objectId |
是 |
string |
模型id |
attributeList |
是 |
list |
属性信息 |
参数示例
{
"publicClass": "updateAttribute",
"objectId": "HOST",
"attributeList": [
{
"inheritObjectId": "",
"custom": "false",
"description": "",
"notifyDenied": false,
"isInherit": false,
"required": "true",
"tips": "",
"protected": true,
"readonly": "false",
"wordIndexDenied": false,
"unique": "false",
"name": "主机名",
"id": "hostname",
"tag": [
"默认属性"
],
"value": {
"mode": "default",
"struct_define": [ ],
"default_type": "value",
"prefix": "",
"start_value": 0,
"type": "str",
"series_number_length": 0
}
},
{
"inheritObjectId": "",
"custom": "false",
"description": "",
"notifyDenied": false,
"isInherit": false,
"required": "false",
"tips": "",
"protected": true,
"readonly": "false",
"wordIndexDenied": false,
"unique": "false",
"name": "agent版本",
"id": "agentVersion",
"tag": [
"默认属性"
],
"value": {
"mode": "default",
"struct_define": [ ],
"default_type": "value",
"prefix": "",
"start_value": 0,
"type": "str",
"series_number_length": 0
}
}
]
}
4、删除模型属性
备注
参数
参数名 |
必选 |
类型 |
说明 |
publicClass |
是 |
string |
方法名(deleteModelAttribute) |
objectId |
是 |
string |
模型id |
idList |
是 |
list |
属性id |
参数示例
{
"publicClass": "deleteModelAttribute",
"objectId": "HOST",
"idList": [
"hostname",
"agentVersion"
]
}
5、新增/修改实例
参数
参数名 |
必选 |
类型 |
说明 |
publicClass |
是 |
string |
方法名(新增:addExample/修改:updateExample) |
objectId |
是 |
string |
模型id |
exampleList |
是 |
list |
实例信息 |
参数示例
{
"publicClass": "addExample",
"objectId": "HOST",
"exampleList": [
{
"_agentHeartBeat": -1,
"_agentStatus": "未安装",
"_object_id": "HOST",
"_object_version": 38,
"_orderIP_ip": "00000000000000000BOiMM",
"_ts": 1637044809,
"_version": 1,
"creator": "easyops",
"ctime": "2021-11-16 14:40:09",
"deviceId": "5d0e2325d5096",
"hostname": "f2c-test2",
"instanceId": "5d0e2325d5096",
"ip": "10.10.10.10",
"org": 212100709
}
]
}
4、删除实例
参数
参数名 |
必选 |
类型 |
说明 |
publicClass |
是 |
string |
方法名(deleteExample) |
objectId |
是 |
string |
模型id |
instanceIdList |
是 |
list |
实例id |
参数示例
{
"publicClass": "deleteExample",
"objectId": "HOST",
"instanceIdList": [
"5d0e2325d5096"
]
}
返回示例
{
"errorCode": 0,
"message": "success",
"responseBody": {
"result": "成功"
},
"time": 1643092984178
}
七、返回参数说明
参数名 |
类型 |
说明 |
errorCode |
int |
0 为成功,其他为失败 |
message |
string |
成功时,返回 success,失败则返回错误信息 |
time |
long |
响应时间 |
responseBody |
object |
返回结果集 |
八、备注
- objectId 第三方模型id
- attributeList 第三方模型信息
- exampleList 第三方实例信息