Flashcat API

创建网络设备

开发中

POST

https://api.flashcat.cloud/api/n9e-plus/network-devices

最后修改时间：2024-03-20 08:01:55

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.flashcat.cloud/api/n9e-plus/network-devices' \
--header 'Content-Type: application/json' \
--data-raw '{
    "group_id": 1,
    "ip": "10.201.0.3",
    "dc": "shanghai",
    "tags": [
        "aa=aa",
        "bb=bb"
    ],
    "board_url": "http://10.206.0.11:8765/dashboards/2?datasource=52&ident=${ip}",
    "note": "测试",
    "target_idents": [
        "tt-fc-dev01.nj"
    ],
    "snmp_tpl_ids": [
        2
    ],
    "snmp_version": 2,
    "snmp_schema": "udp",
    "snmp_port": 161,
    "snmp_timeout": 5,
    "auth": {
        "community": "public"
    },
    "collect_disabled": 0,
    "custom_thresholds": [
        {
            "threshold":{
                "net_in_util":0.8,
                "net_out_util":0.8
            },
            "labels":{
                "snmp_index":"1.1"
            }
        }
    ]
}'

响应示例

{
    "err": "string"
}

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

id

integer

可选

ip

string

IP

必需

dc

string

机房

可选

tags

array[string]

附加标签

可选

key=value key2=value2

board_url

string

仪表盘链接

可选

note

string

备注

可选

collect_disabled

integer

是否启用

可选

0 启用 1禁用，默认为0

target_idents

array[string]

采集Agent

可选

采集机器标识

snmp_tpl_ids

array[integer]

采集模板

可选

采集模板ids

group_id

integer

业务组id

必需

snmp_version

integer

SNMP版本

可选

snmp_schema

string

SNMP协议

可选

snmp_port

integer

SNMP端口

可选

snmp_timeout

integer

SNMP超时

可选

auth

object

授权信息

可选

sec_name

string

用户名

可选

auth_password

string

认证密码

可选

auth_proto

string

认证协议

可选

可以是 "MD5", "SHA", "SHA224", "SHA256", "SHA384", "SHA512" 或者 ""

sec_level

string

安全级别

可选

安全级别；可以是 "noAuthNoPriv", "authNoPriv", 或 "authPriv"

context_name

string

上下文名称

可选

priv_proto

string

加密协议

可选

用于加密消息的隐私协议；可以是 "DES", "AES", "AES192", "AES192C", "AES256", "AES256C" 或者 ""

priv_password

string

加密密码

可选

create_at

integer

可选

create_by

string

可选

update_at

integer

可选

update_by

string

可选

sys_name

string

设备名称

可选

创建页面不需要此字段

sys_desc

string

设备型号

可选

创建页面不需要此字段，此字段比较长，前端可以处理下

sys_uptime

string

Uptime

可选

创建页面不需要此字段

sys_location

string

Location

可选

创建页面不需要此字段

custom_thresholds

array [object {2}]

必需

threshold

object

必需

map[string]float64

labels

object

必需

map[string]string

custom_thresholds_tables

array [array]

必需

object

可选

示例

返回响应

🟢200成功

application/json

Body

err

string

必需

删除网络设备

网络设备详情