操作日志

2.1.1查询操作日志列表

接口地址

GET  /NSphere/api/operation-log/list

接口描述

查询操作日志列表。说明：category、categoryId、relatedCategory、targetId可以组合使用，常见用法为category与targetId组合或category、targetId单独使用。E0930版本新增接口。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
targetId	操作对象ID（如虚拟机、主机等）	query	false	integer(int64)
categoryId	关联任务操作对象的ID，categoryId使用时必须传入targetId和relatedCategory才能生效，例如在查询与动态资源业务扩展有关联的虚拟机动作日志时，那么传入categoryId=动态资源扩展的ID，targetId=关联虚拟机的id，relatedCategory（操作分类）=50（动态资源扩展）	query	false	integer(int64)
offset	偏移量	query	false	integer(int32)
limit	返回数量	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时默认不排序。	query	false	integer(int32)
sortField	排序字段，支持字段：loginName，userName，operStartTime，operTime，address，category，targetName，result，level，event。	query	false	string
loginName	登录名	query	false	string
userName	操作员姓名	query	false	string
operTime_from	操作完成时间范围起端，输入格式为：年-月-日，例如2023-10-24	query	false	string(date-time)
operTime_to	操作完成时间范围末端，输入格式为：年-月-日，例如2023-10-24	query	false	string(date-time)
operStartTime_from	操作开始时间范围起端，输入格式为：年-月-日，例如2023-10-24	query	false	string(date-time)
operStartTime_to	操作开始时间范围末端，输入格式为：年-月-日，例如2023-10-24	query	false	string(date-time)
address	登录地址	query	false	string
category	操作分类，枚举：0-所有动作，1-操作员动作，2-系统配置，3-云资源动作，4-数据中心动作，5-主机动作，6-存储动作，7-网络动作，8-集群动作，10-虚拟机动作，15-模板动作，16-OVF模板动作，21-备份动作，22-恢复动作，50-动态资源业务扩展动作，60-虚拟存储动作，80-告警管理动作，90-资源池调度业务动作，120-站点容灾动作，130-管理平台动作，140-存储适配器动作，150-云彩虹动作，170-命令行动作，180-电子流动作，194-LAN-Free动作，196-热补丁动作，197-外部云资源动作，198-外部云虚拟机迁移动作，199-外部云备份策略动作，200-本地磁盘动作，204-裸金属动作，205-组件动作，206-备份中心动作，207-主机防火墙动作，208-升级管理动作，209-标签动作，211-主机配置文件动作，213-密评配置动作，217-端口组动作，218-调度任务动作，219-资源分析动作，220-分布式防火墙动作，221-物理交换机动作，222-延展域动作	query	false	integer(int32)
relatedCategory	关联任务的类型，categoryId、relatedCategory、targetId配对使用，其枚举值和category一致	query	false	integer(int32)
result	执行结果，枚举：0-成功；1-失败；2-部分成功	query	false	integer(int32)
description	操作描述（模糊查询）	query	false	string
targetName	操作对象（模糊查询）	query	false	string
level	风险级别，枚举：1000-高，2000-中，3000-低	query	false	integer(int32)
event	事件类型，枚举：0-所有类型，1001-删除，1002-还原，1003-格式化，1004-转化，1005-迁移，1006-初始化，1008-挂载，1009-解挂，1010-更新签名，2001-增加，2002-修改，2003-克隆，2004-备份，2005-部署，2006-进入维护，2007-退出维护，2008-拷贝，2009-导入，2010-导出，2011-分发，2012-配置，2013-管理，2014-升级，2015-执行命令，2018-安装，2019-卸载，2020-注册，2021-进入隔离，2022-退出隔离，3001-启动，3002-关闭，3003-重启，3004-暂停，3005-休眠，3006-恢复，3007-登录，3008-注销，3009-连接，3010-断开连接，3011-取消，3012-扫描，3013-刷新，3014-同步，3019-检测，5003-日志文件收集，5004-提交	query	false	integer(int32)

响应状态

状态码	说明	schema
200	OK	RpcPagingLoadResultApiOperationLogVO

响应参数

参数名称	参数说明	类型	schema
state		integer(int32)	integer(int32)
errorCode		integer(int32)	integer(int32)
successMessage		string
failureMessage		string
data		array	ApiOperationLogVO
id	操作日志ID	integer(int64)
loginName	登录名	string
userName	操作员姓名	string
operStartTime	开始时间	string(date-time)
operTime	完成时间	string(date-time)
address	登录地址	string
category	操作分类，枚举：0-所有动作，1-操作员动作，2-系统配置，3-云资源动作，4-数据中心动作，5-主机动作，6-存储动作，7-网络动作，8-集群动作，10-虚拟机动作，15-模板动作，16-OVF模板动作，21-备份动作，22-恢复动作，50-动态资源业务扩展动作，60-虚拟存储动作，80-告警管理动作，90-资源池调度业务动作，120-站点容灾动作，130-管理平台动作，140-存储适配器动作，150-云彩虹动作，170-命令行动作，180-电子流动作，194-LAN-Free动作，196-热补丁动作，197-外部云资源动作，198-外部云虚拟机迁移动作，199-外部云备份策略动作，200-本地磁盘动作，204-裸金属动作，205-组件动作，206-备份中心动作，207-主机防火墙动作，208-升级管理动作，209-标签动作，211-主机配置文件动作，213-密评配置动作，217-端口组动作，218-调度任务动作，219-资源分析动作，220-分布式防火墙动作，221-物理交换机动作，222-延展域动作	integer(int32)
description	操作描述	string
result	执行结果	integer(int32)
progress	进度	integer(int32)
failureReason	失败原因（存在失败的结果，才会返回该字段）	string
targetName	操作对象	string
level	风险级别，枚举：1000-高，2000-中，3000-低	integer(int32)
event	事件类型，枚举：0-所有类型，1001-删除，1002-还原，1003-格式化，1004-转化，1005-迁移，1006-初始化，1008-挂载，1009-解挂，1010-更新签名，2001-增加，2002-修改，2003-克隆，2004-备份，2005-部署，2006-进入维护，2007-退出维护，2008-拷贝，2009-导入，2010-导出，2011-分发，2012-配置，2013-管理，2014-升级，2015-执行命令，2018-安装，2019-卸载，2020-注册，2021-进入隔离，2022-退出隔离，3001-启动，3002-关闭，3003-重启，3004-暂停，3005-休眠，3006-恢复，3007-登录，3008-注销，3009-连接，3010-断开连接，3011-取消，3012-扫描，3013-刷新，3014-同步，3019-检测，5003-日志文件收集，5004-提交	integer(int32)
offset		integer(int32)	integer(int32)
totalLength		integer(int32)	integer(int32)
success		boolean
partSuccess		boolean

响应示例

{

"state": null,

"errorCode": null,

"successMessage": null,

"failureMessage": null,

"data": [

{

"id": null,

"loginName": null,

"userName": null,

"operStartTime": null,

"operTime": null,

"address": null,

"category": null,

"description": null,

"result": null,

"progress": null,

"failureReason": null,

"targetName": null,

"level": null,

"event": null

}

],

"offset": null,

"totalLength": null,

"success": true,

"partSuccess": true

}