dp2API之GetOperLogs - DigitalPlatform/dp2 GitHub Wiki

GetOperLogs() – 获取多条操作日志

            LibraryServerResult GetOperLogs(
            string strFileName,
            long lIndex,
            long lHint,
            int nCount,
            string strStyle,
            string strFilter,
            out OperLogInfo[] records)

用途

获得多条操作日志。

参数

因GetOperLogs()API与GetOperLogs()API两个接口相同参数很多,所以本文档仅讲解与GetOperLogs()API不同的参数,其他参数信息详见GetOperLog() – 获取操作日志

int nCount

要获得的元素数量。若为-1表示希望获得尽可能多的元素

out OperLogInfo[] records

返回系统的操作日志信息

实例演示 获取多条日志操作记录

一条GetOperLogs接口的实际操作用例,可以参考输入参数来进行学习,完成获取获取多条日志操作记录的操作,需要注意的是,操作日志记录的名称和序号实际运用要改成自己有的操作日志记录的名称和序号

请求参数

请求包要用到的参数解释:

strFileName 称为20230328.log的第1条操作日志
lHint 无暗示参数可填-1但是不可为空
nCount 获取元素的数量,填-1代表尽可能多的获取元素
strStyle 风格,可为空
strFilter 过滤器,为空表示接收返回所有类型消息

请求包的数据部分如下:

{
  "strFileName":"20230328.log",
  "lIndex":"1",
  "lHint":"-1",
  "nCount":"-1",
  "strStyle":"",
  "strFilter":""
}

响应结果

响应结果的返回信息详解:

ErrorCode 错误代码为0,也就是没有错误
ErrorInfo 错误信息为空,也就是没有错误
Value 返回值为1,代表成功
records 返回的日志记录
AttachmentLength 附件长度
AttachmentLength 暗示参数
Index 在返回结果中表示返回结果的序号,例如返回的第一条日志记录,它的序号就是1,第二条就是2
Xml 操作日志的Xml信息

响应信息如下:

返回的操作日志记录太多,所以这里展示省略大部分,只展示三条

{
    "GetOperLogsResult": {
        "ErrorCode": 0,
        "ErrorInfo": "",
        "Value": 1
    },
    "records": [
        {
            "AttachmentLength": 512178,
            "HintNext": 1564823,
            "Index": 6,
            "Xml": "<root><operation>writeRes</operation><operator>supervisor</operator><operTime>Tue, 28 Mar 2023 10:47:01 +0800</operTime><requestResPath>中文图书/9/object/0</requestResPath><resPath>中文图书/0000000009/object/0</resPath><ranges>1024000-1535999</ranges><totalLength>3662715</totalLength><metadata></metadata><style>gzip</style><clientAddress via=\"net.pipe://localhost/dp2library/XE\">localhost</clientAddress><version>1.06</version></root>"
        },
        {
            "AttachmentLength": 512178,
            "HintNext": 2077501,
            "Index": 7,
            "Xml": "<root><operation>writeRes</operation><operator>supervisor</operator><operTime>Tue, 28 Mar 2023 10:47:01 +0800</operTime><requestResPath>中文图书/9/object/0</requestResPath><resPath>中文图书/0000000009/object/0</resPath><ranges>1536000-2047999</ranges><totalLength>3662715</totalLength><metadata></metadata><style>gzip</style><clientAddress via=\"net.pipe://localhost/dp2library/XE\">localhost</clientAddress><version>1.06</version></root>"
        },
        {
            "AttachmentLength": 512178,
            "HintNext": 2590179,
            "Index": 8,
            "Xml": "<root><operation>writeRes</operation><operator>supervisor</operator><operTime>Tue, 28 Mar 2023 10:47:01 +0800</operTime><requestResPath>中文图书/9/object/0</requestResPath><resPath>中文图书/0000000009/object/0</resPath><ranges>2048000-2559999</ranges><totalLength>3662715</totalLength><metadata></metadata><style>gzip</style><clientAddress via=\"net.pipe://localhost/dp2library/XE\">localhost</clientAddress><version>1.06</version></root>"
        }
    ]
}
⚠️ **GitHub.com Fallback** ⚠️