oneterm接口文档
启动api后也可查看swagger文档 http://127.0.0.1:58080/swagger/index.html
资产接口
创建资产
-
POST
/api/oneterm/v1/asset
-
参数
参数名 示例值 参数类型 是否必填 参数描述 parent_id 1 int 是 父文件夹id name 资产1 string 是 资产名称,唯一 comment 注释1 string 否 资产备注 ip 192.168.20.82 string 否 资产ip protocols [ssh:22] []string 否 协议和端口组合的列表 gateway_id 1 int 否 使用的网关id authorization {1:[123, 456]} map[int][]int 是 账号和授权用户列表字典,key为账号id,value为acl rid的列表 accessAuth {"cmd_ids":[2],"start":"2024-01-30T00:00:00+08:00","end":"2024-01-31T23:59:59+08:00","ranges":[{"week":0,"times":["00:00~00:30"]},{"week":1,"times":[]},{"week":2,"times":[]},{"week":3,"times":[]},{"week":4,"times":[]},{"week":5,"times":[]},{"week":6,"times":[]}],"allow":true} AccessAuth 是 资产接入控制,cmd_ids为命令过滤id的列表,start与end为接入控制生效时间,ranges为选择的时间,allow为选择时间内是允许或拒绝接入 -
返回结果
{
"code": 0,
"data": null,
"message": "ok"
}
账号接口
创建账号
-
POST
/api/oneterm/v1/account
-
参数
参数名 示例值 参数类型 是否必填 参数描述 name 资产1 string 是 账号名称,唯一 account_type 1 int 是 账号类型 1 密码 2 密钥 account root string 是 账号 password abc123 string 否 账号密码 pk -----BEGIN RSA PRIVATE KEY-----... string 否 私钥 phrase 123456 string 否 创建私钥时使用的phrase -
返回结果
{
"code": 0,
"data": null,
"message": "ok"
}