1908 lines
81 KiB
Markdown
1908 lines
81 KiB
Markdown
---
|
||
title: middleware-agent
|
||
language_tabs:
|
||
- shell: Shell
|
||
- http: HTTP
|
||
- javascript: JavaScript
|
||
- ruby: Ruby
|
||
- python: Python
|
||
- php: PHP
|
||
- java: Java
|
||
- go: Go
|
||
toc_footers: []
|
||
includes: []
|
||
search: true
|
||
code_clipboard: true
|
||
highlight_theme: darkula
|
||
headingLevel: 2
|
||
generator: "@tarslib/widdershins v4.0.23"
|
||
|
||
---
|
||
|
||
# middleware-agent
|
||
|
||
Base URLs:
|
||
|
||
# Authentication
|
||
|
||
# magent/通用接口
|
||
|
||
## POST 获取系统版本信息（POST 请求）。
|
||
|
||
POST /api/version
|
||
|
||
<p>该接口返回系统的版本信息，包括提交 ID、描述、时间、标签名称、构建时间以及分支名称。
|
||
接口支持加密和解密协议，并记录操作日志。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"version": {
|
||
"commitId": "",
|
||
"commitDescribe": "",
|
||
"commitTime": "",
|
||
"tagName": "",
|
||
"buildTime": "",
|
||
"gitBranch": ""
|
||
},
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|
||
|-----|---------------------------------------------------------|------|-----------------------------------------------------------|
|
||
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | none | [ProtocolRespVersionResp](#schemaprotocolrespversionresp) |
|
||
|
||
## GET 获取系统版本信息（GET 请求）。
|
||
|
||
GET /api/version
|
||
|
||
<p>该接口提供系统版本信息，与 POST 接口返回的数据相同。
|
||
支持加密协议和操作日志记录。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"version": {
|
||
"commitId": "",
|
||
"commitDescribe": "",
|
||
"commitTime": "",
|
||
"tagName": "",
|
||
"buildTime": "",
|
||
"gitBranch": ""
|
||
},
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespVersionResp](#schemaprotocolrespversionresp)|
|
||
|
||
# magent/系统信息接口
|
||
|
||
## GET 获取操作系统信息。
|
||
|
||
GET /api/systemInfo/osInfo
|
||
|
||
<p>该接口返回操作系统名称以及系统启动时间。返回数据通过加密协议进行保护，
|
||
并记录操作日志。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"os": "",
|
||
"bootTime": 0,
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespGetOsInfoResp](#schemaprotocolrespgetosinforesp)|
|
||
|
||
## GET 获取处理器信息。
|
||
|
||
GET /api/systemInfo/processorInfo
|
||
|
||
<p>该接口返回处理器的相关信息（如 CPU 详情）。返回数据通过加密协议进行保护，
|
||
并记录操作日志。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"cpuInfo": {
|
||
"cpuVendor": "",
|
||
"cpuName": "",
|
||
"processorId": "",
|
||
"cpuIdentifier": "",
|
||
"microArchitecture": "",
|
||
"cpu64bit": false,
|
||
"cpuVendorFreq": 0,
|
||
"physicalCpus": 0,
|
||
"physicalCores": 0,
|
||
"logicalCpu": 0
|
||
},
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespGetProcessorInfoResp](#schemaprotocolrespgetprocessorinforesp)|
|
||
|
||
## GET 获取硬件信息。
|
||
|
||
GET /api/systemInfo/hwInfo
|
||
|
||
<p>该接口返回系统硬件的相关信息。返回数据通过加密协议进行保护，
|
||
并记录操作日志。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"hwInfo": {
|
||
"model": "",
|
||
"manufacturer": "",
|
||
"uuid": "",
|
||
"serialNumber": "",
|
||
"firmware": {
|
||
"name": "",
|
||
"version": "",
|
||
"manufacturer": "",
|
||
"releaseDate": "",
|
||
"description": ""
|
||
},
|
||
"mb": {
|
||
"version": "",
|
||
"manufacturer": "",
|
||
"model": "",
|
||
"serialNumber": ""
|
||
},
|
||
"memoryInfo": {
|
||
"physicalMemory": {
|
||
"totalMemory": 0,
|
||
"freeMemory": 0
|
||
},
|
||
"swapMemory": {
|
||
"totalMemory": 0,
|
||
"freeMemory": 0
|
||
},
|
||
"hwMemory": [
|
||
{
|
||
"bankLabel": "",
|
||
"capacity": 0,
|
||
"clockSpeed": 0,
|
||
"manufacturer": "",
|
||
"memoryType": "",
|
||
"partNumber": "",
|
||
"serialNumber": ""
|
||
}
|
||
]
|
||
},
|
||
"fileStoreInfo": {
|
||
"fileStore": [
|
||
{
|
||
"name": "",
|
||
"volume": "",
|
||
"mountPoint": "",
|
||
"uuid": "",
|
||
"fsType": "",
|
||
"description": "",
|
||
"freeSpace": 0,
|
||
"totalSpace": 0,
|
||
"usableSpace": 0
|
||
}
|
||
],
|
||
"hwDisk": [
|
||
{
|
||
"name": "",
|
||
"model": "",
|
||
"serial": "",
|
||
"size": 0
|
||
}
|
||
]
|
||
},
|
||
"networkInfo": {
|
||
"ifNetwork": [
|
||
{
|
||
"index": 0,
|
||
"name": "",
|
||
"dispayName": "",
|
||
"mac": "",
|
||
"ipv4": [
|
||
"192.168.1.1",
|
||
"10.0.0.1"
|
||
],
|
||
"ipv6": [
|
||
"fe80::1",
|
||
"::1"
|
||
],
|
||
"ifOperStatus": 0,
|
||
"mtu": 0,
|
||
"speed": 0,
|
||
"bytesRecv": 0,
|
||
"bytesSent": 0,
|
||
"packetsRecv": 0,
|
||
"packetsSent": 0,
|
||
"inErrors": 0,
|
||
"outErrors": 0,
|
||
"inDrops": 0
|
||
}
|
||
],
|
||
"hostName": "",
|
||
"domainName": "",
|
||
"dnsServers": [
|
||
""
|
||
],
|
||
"ipv4DefaultGateway": "",
|
||
"ipv6DefaultGateway": ""
|
||
}
|
||
},
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespGetHwInfoResp](#schemaprotocolrespgethwinforesp)|
|
||
|
||
## GET 获取网络信息。
|
||
|
||
GET /api/systemInfo/networkInfo
|
||
|
||
<p>该接口返回系统网络相关信息。返回数据通过加密协议进行保护，并记录操作日志。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"networkInfo": {
|
||
"ifNetwork": [
|
||
{
|
||
"index": 0,
|
||
"name": "",
|
||
"dispayName": "",
|
||
"mac": "",
|
||
"ipv4": [
|
||
"192.168.1.1",
|
||
"10.0.0.1"
|
||
],
|
||
"ipv6": [
|
||
"fe80::1",
|
||
"::1"
|
||
],
|
||
"ifOperStatus": 0,
|
||
"mtu": 0,
|
||
"speed": 0,
|
||
"bytesRecv": 0,
|
||
"bytesSent": 0,
|
||
"packetsRecv": 0,
|
||
"packetsSent": 0,
|
||
"inErrors": 0,
|
||
"outErrors": 0,
|
||
"inDrops": 0
|
||
}
|
||
],
|
||
"hostName": "",
|
||
"domainName": "",
|
||
"dnsServers": [
|
||
""
|
||
],
|
||
"ipv4DefaultGateway": "",
|
||
"ipv6DefaultGateway": ""
|
||
},
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespGetNetworkInfoResp](#schemaprotocolrespgetnetworkinforesp)|
|
||
|
||
## GET 获取内存信息。
|
||
|
||
GET /api/systemInfo/memoryInfo
|
||
|
||
<p>该接口返回系统内存相关信息。返回数据通过加密协议进行保护，并记录操作日志。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"memoryInfo": {
|
||
"physicalMemory": {
|
||
"totalMemory": 0,
|
||
"freeMemory": 0
|
||
},
|
||
"swapMemory": {
|
||
"totalMemory": 0,
|
||
"freeMemory": 0
|
||
},
|
||
"hwMemory": [
|
||
{
|
||
"bankLabel": "",
|
||
"capacity": 0,
|
||
"clockSpeed": 0,
|
||
"manufacturer": "",
|
||
"memoryType": "",
|
||
"partNumber": "",
|
||
"serialNumber": ""
|
||
}
|
||
]
|
||
},
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespGetMemoryInfoResp](#schemaprotocolrespgetmemoryinforesp)|
|
||
|
||
## GET 获取文件存储信息。
|
||
|
||
GET /api/systemInfo/fileStoreInfo
|
||
|
||
<p>该接口返回系统文件系统以及磁盘相关信息。返回数据通过加密协议进行保护，并记录操作日志。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"fileStoreInfo": {
|
||
"fileStore": [
|
||
{
|
||
"name": "",
|
||
"volume": "",
|
||
"mountPoint": "",
|
||
"uuid": "",
|
||
"fsType": "",
|
||
"description": "",
|
||
"freeSpace": 0,
|
||
"totalSpace": 0,
|
||
"usableSpace": 0
|
||
}
|
||
],
|
||
"hwDisk": [
|
||
{
|
||
"name": "",
|
||
"model": "",
|
||
"serial": "",
|
||
"size": 0
|
||
}
|
||
]
|
||
},
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
]
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespGetFileStoreInfoResp](#schemaprotocolrespgetfilestoreinforesp)|
|
||
|
||
# magent/系统资源占用信息接口
|
||
|
||
## GET 获取当前系统资源使用信息。
|
||
|
||
GET /api/systemInfo/usage
|
||
|
||
<p>此方法使用了加密协议和操作日志注解，提供对系统资源使用情况的读取操作。</p>
|
||
|
||
> 返回示例
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"status": 0,
|
||
"message": [
|
||
"操作成功"
|
||
],
|
||
"resourceUsage": {
|
||
"data": [
|
||
{
|
||
"cpuUsagePercent": 0,
|
||
"memoryUsagePercent": 0
|
||
}
|
||
],
|
||
"head": 0,
|
||
"tail": 0,
|
||
"size": 0,
|
||
"capacity": 0
|
||
}
|
||
},
|
||
"code": 0
|
||
}
|
||
```
|
||
|
||
### 返回结果
|
||
|
||
|状态码|状态码含义|说明|数据模型|
|
||
|---|---|---|---|
|
||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|[ProtocolRespGetResourceUsageResp](#schemaprotocolrespgetresourceusageresp)|
|
||
|
||
# 数据模型
|
||
|
||
<h2 id="tocS_Pet">Pet</h2>
|
||
|
||
<a id="schemapet"></a>
|
||
<a id="schema_Pet"></a>
|
||
<a id="tocSpet"></a>
|
||
<a id="tocspet"></a>
|
||
|
||
```json
|
||
{
|
||
"id": 1,
|
||
"category": {
|
||
"id": 1,
|
||
"name": "string"
|
||
},
|
||
"name": "doggie",
|
||
"photoUrls": [
|
||
"string"
|
||
],
|
||
"tags": [
|
||
{
|
||
"id": 1,
|
||
"name": "string"
|
||
}
|
||
],
|
||
"status": "available"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|id|integer(int64)|true|none||宠物ID编号|
|
||
|category|[Category](#schemacategory)|true|none||分组|
|
||
|name|string|true|none||名称|
|
||
|photoUrls|[string]|true|none||照片URL|
|
||
|tags|[[Tag](#schematag)]|true|none||标签|
|
||
|status|string|true|none||宠物销售状态|
|
||
|
||
#### 枚举值
|
||
|
||
|属性|值|
|
||
|---|---|
|
||
|status|available|
|
||
|status|pending|
|
||
|status|sold|
|
||
|
||
<h2 id="tocS_Category">Category</h2>
|
||
|
||
<a id="schemacategory"></a>
|
||
<a id="schema_Category"></a>
|
||
<a id="tocScategory"></a>
|
||
<a id="tocscategory"></a>
|
||
|
||
```json
|
||
{
|
||
"id": 1,
|
||
"name": "string"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|id|integer(int64)|false|none||分组ID编号|
|
||
|name|string|false|none||分组名称|
|
||
|
||
<h2 id="tocS_Tag">Tag</h2>
|
||
|
||
<a id="schematag"></a>
|
||
<a id="schema_Tag"></a>
|
||
<a id="tocStag"></a>
|
||
<a id="tocstag"></a>
|
||
|
||
```json
|
||
{
|
||
"id": 1,
|
||
"name": "string"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|id|integer(int64)|false|none||标签ID编号|
|
||
|name|string|false|none||标签名称|
|
||
|
||
<h2 id="tocS_VersionInfo">VersionInfo</h2>
|
||
|
||
<a id="schemaversioninfo"></a>
|
||
<a id="schema_VersionInfo"></a>
|
||
<a id="tocSversioninfo"></a>
|
||
<a id="tocsversioninfo"></a>
|
||
|
||
```json
|
||
{
|
||
"commitId": "abc12345",
|
||
"commitDescribe": "Fix bug in user login",
|
||
"commitTime": "2023-01-07T12:00:00Z",
|
||
"tagName": "v1.0.0",
|
||
"buildTime": "2023-01-07T14:00:00Z",
|
||
"gitBranch": "main"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|commitId|string|false|none||提交 ID。<br /><p><br />表示系统当前版本的代码提交记录的唯一标识，例如 "abc12345"。<br /></p><br />系统当前版本的代码提交记录的唯一标识。|
|
||
|commitDescribe|string|false|none||提交描述。<br /><p><br />表示系统当前版本的代码提交的具体描述信息，例如 "Fix bug in user login"。<br /></p><br />系统当前版本的代码提交的具体描述信息。|
|
||
|commitTime|string|false|none||提交时间。<br /><p><br />表示代码提交的时间戳，例如 "2023-01-07T12:00:00Z"。<br /></p><br />代码提交的时间戳。|
|
||
|tagName|string|false|none||标签名称。<br /><p><br />表示系统当前版本的标签信息，例如 "v1.0.0"。<br /></p><br />系统当前版本的标签信息。|
|
||
|buildTime|string|false|none||构建时间。<br /><p><br />表示当前系统版本构建的时间戳，例如 "2023-01-07T14:00:00Z"。<br /></p><br />系统版本的构建时间戳。|
|
||
|gitBranch|string|false|none||Git 分支。<br /><p><br />表示代码版本对应的 Git 分支名称，例如 "main"。<br /></p><br />代码版本对应的 Git 分支名称。|
|
||
|
||
<h2 id="tocS_ResourceUsage">ResourceUsage</h2>
|
||
|
||
<a id="schemaresourceusage"></a>
|
||
<a id="schema_ResourceUsage"></a>
|
||
<a id="tocSresourceusage"></a>
|
||
<a id="tocsresourceusage"></a>
|
||
|
||
```json
|
||
{
|
||
"cpuUsagePercent": 0,
|
||
"memoryUsagePercent": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|cpuUsagePercent|integer|false|none||CPU 使用率（百分比）。|
|
||
|memoryUsagePercent|integer|false|none||内存使用率（百分比）。|
|
||
|
||
<h2 id="tocS_VersionResp">VersionResp</h2>
|
||
|
||
<a id="schemaversionresp"></a>
|
||
<a id="schema_VersionResp"></a>
|
||
<a id="tocSversionresp"></a>
|
||
<a id="tocsversionresp"></a>
|
||
|
||
```json
|
||
{
|
||
"version": {
|
||
"commitId": "abc12345",
|
||
"commitDescribe": "Fix bug in user login",
|
||
"commitTime": "2023-01-07T12:00:00Z",
|
||
"tagName": "v1.0.0",
|
||
"buildTime": "2023-01-07T14:00:00Z",
|
||
"gitBranch": "main"
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|version|[VersionInfo](#schemaversioninfo)|false|none||版本信息内容。<br /><p><br />表示当前系统或模块的版本详情信息，包括版本号、发布日期以及描述信息。<br />版本信息内容，包括版本号、发布日期以及描述信息|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|
||
<h2 id="tocS_CircularQueueResourceUsage">CircularQueueResourceUsage</h2>
|
||
|
||
<a id="schemacircularqueueresourceusage"></a>
|
||
<a id="schema_CircularQueueResourceUsage"></a>
|
||
<a id="tocScircularqueueresourceusage"></a>
|
||
<a id="tocscircularqueueresourceusage"></a>
|
||
|
||
```json
|
||
{
|
||
"data": [
|
||
{
|
||
"cpuUsagePercent": 0,
|
||
"memoryUsagePercent": 0
|
||
}
|
||
],
|
||
"head": 0,
|
||
"tail": 0,
|
||
"size": 0,
|
||
"capacity": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|data|[[ResourceUsage](#schemaresourceusage)]|false|none||存储队列的数组|
|
||
|head|integer|false|none||队列头指针|
|
||
|tail|integer|false|none||队列尾指针|
|
||
|size|integer|false|none||当前队列中的元素数量|
|
||
|capacity|integer|false|none||队列的最大容量|
|
||
|
||
<h2 id="tocS_ProtocolRespVersionResp">ProtocolRespVersionResp</h2>
|
||
|
||
<a id="schemaprotocolrespversionresp"></a>
|
||
<a id="schema_ProtocolRespVersionResp"></a>
|
||
<a id="tocSprotocolrespversionresp"></a>
|
||
<a id="tocsprotocolrespversionresp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"version": {
|
||
"commitId": "abc12345",
|
||
"commitDescribe": "Fix bug in user login",
|
||
"commitTime": "2023-01-07T12:00:00Z",
|
||
"tagName": "v1.0.0",
|
||
"buildTime": "2023-01-07T14:00:00Z",
|
||
"gitBranch": "main"
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[VersionResp](#schemaversionresp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|
||
<h2 id="tocS_GetResourceUsageResp">GetResourceUsageResp</h2>
|
||
|
||
<a id="schemagetresourceusageresp"></a>
|
||
<a id="schema_GetResourceUsageResp"></a>
|
||
<a id="tocSgetresourceusageresp"></a>
|
||
<a id="tocsgetresourceusageresp"></a>
|
||
|
||
```json
|
||
{
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]",
|
||
"resourceUsage": {
|
||
"data": [
|
||
{
|
||
"cpuUsagePercent": 0,
|
||
"memoryUsagePercent": 0
|
||
}
|
||
],
|
||
"head": 0,
|
||
"tail": 0,
|
||
"size": 0,
|
||
"capacity": 0
|
||
}
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|resourceUsage|[CircularQueueResourceUsage](#schemacircularqueueresourceusage)|false|none||包含资源使用信息的环形队列。<br />类型为{@link ResourceUsage}。<br />最近一段时间内的资源占用信息。|
|
||
|
||
<h2 id="tocS_GetOsInfoResp">GetOsInfoResp</h2>
|
||
|
||
<a id="schemagetosinforesp"></a>
|
||
<a id="schema_GetOsInfoResp"></a>
|
||
<a id="tocSgetosinforesp"></a>
|
||
<a id="tocsgetosinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"os": "string",
|
||
"bootTime": 0,
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|os|string|false|none||操作系统名称。<br /><p><br />表示系统的操作系统名称，例如 "Ubuntu 20.04" 或 "Windows 10"。<br /></p><br />操作系统名称，例如 Ubuntu 20.04 或 Windows 10|
|
||
|bootTime|integer|false|none||系统启动时间。<br /><p><br />表示系统最近一次启动的时间，格式为{@link Timestamp}。<br />例如 "2023-01-07T08:00:00"。<br /></p><br />系统启动时间，例如 2023-01-07T08:00:00|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|
||
<h2 id="tocS_ProtocolRespGetResourceUsageResp">ProtocolRespGetResourceUsageResp</h2>
|
||
|
||
<a id="schemaprotocolrespgetresourceusageresp"></a>
|
||
<a id="schema_ProtocolRespGetResourceUsageResp"></a>
|
||
<a id="tocSprotocolrespgetresourceusageresp"></a>
|
||
<a id="tocsprotocolrespgetresourceusageresp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]",
|
||
"resourceUsage": {
|
||
"data": [
|
||
{
|
||
"cpuUsagePercent": 0,
|
||
"memoryUsagePercent": 0
|
||
}
|
||
],
|
||
"head": 0,
|
||
"tail": 0,
|
||
"size": 0,
|
||
"capacity": 0
|
||
}
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[GetResourceUsageResp](#schemagetresourceusageresp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|
||
<h2 id="tocS_ProtocolRespGetOsInfoResp">ProtocolRespGetOsInfoResp</h2>
|
||
|
||
<a id="schemaprotocolrespgetosinforesp"></a>
|
||
<a id="schema_ProtocolRespGetOsInfoResp"></a>
|
||
<a id="tocSprotocolrespgetosinforesp"></a>
|
||
<a id="tocsprotocolrespgetosinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"os": "string",
|
||
"bootTime": 0,
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[GetOsInfoResp](#schemagetosinforesp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|
||
<h2 id="tocS_ProcessorInfo">ProcessorInfo</h2>
|
||
|
||
<a id="schemaprocessorinfo"></a>
|
||
<a id="schema_ProcessorInfo"></a>
|
||
<a id="tocSprocessorinfo"></a>
|
||
<a id="tocsprocessorinfo"></a>
|
||
|
||
```json
|
||
{
|
||
"cpuVendor": "Intel",
|
||
"cpuName": "Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz",
|
||
"processorId": "BFEBFBFF000306C3",
|
||
"cpuIdentifier": "x86_64 Family 6 Model 158 Stepping 10",
|
||
"microArchitecture": "Comet Lake",
|
||
"cpu64bit": true,
|
||
"cpuVendorFreq": 3800000000,
|
||
"physicalCpus": 1,
|
||
"physicalCores": 8,
|
||
"logicalCpu": 16
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|cpuVendor|string|false|none||CPU 厂商。<br /><p><br />表示处理器的制造商名称，例如 "Intel"、"AMD"。<br /></p><br />处理器的制造商名称。|
|
||
|cpuName|string|false|none||CPU 名称。<br /><p><br />表示处理器的完整型号名称，例如 "Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz"。<br /></p><br />处理器的完整型号名称。|
|
||
|processorId|string|false|none||CPU 标识符（Processor ID）。<br /><p><br />表示处理器的唯一标识符，例如 "BFEBFBFF000306C3"。<br /></p><br />处理器的唯一标识符。|
|
||
|cpuIdentifier|string|false|none||CPU 标识信息。<br /><p><br />提供额外的处理器标识信息，例如 "x86_64 Family 6 Model 158 Stepping 10"。<br /></p><br />处理器的标识信息。|
|
||
|microArchitecture|string|false|none||微架构（Micro-Architecture）。<br /><p><br />表示处理器的微架构名称，例如 "Comet Lake"。<br /></p><br />处理器的微架构名称。|
|
||
|cpu64bit|boolean|false|none||是否为 64 位架构。<br /><p><br />表示处理器是否支持 64 位架构。<br /></p><br />处理器是否支持 64 位架构。|
|
||
|cpuVendorFreq|integer(int64)|false|none||CPU 主频（Hz）。<br /><p><br />表示处理器的厂商标称主频（单位：Hz），例如 3800000000 表示 3.80GHz。<br /></p><br />处理器的标称主频（单位：Hz）。|
|
||
|physicalCpus|integer|false|none||物理 CPU 数量。<br /><p><br />表示系统中物理处理器的数量。<br /></p><br />系统中物理处理器的数量。|
|
||
|physicalCores|integer|false|none||物理核心数量。<br /><p><br />表示处理器的物理核心数，例如 8 核。<br /></p><br />处理器的物理核心数。|
|
||
|logicalCpu|integer|false|none||逻辑核心数量。<br /><p><br />表示处理器的逻辑核心数（包括超线程），例如 16 核。<br /></p><br />处理器的逻辑核心数（包括超线程）。|
|
||
|
||
<h2 id="tocS_GetProcessorInfoResp">GetProcessorInfoResp</h2>
|
||
|
||
<a id="schemagetprocessorinforesp"></a>
|
||
<a id="schema_GetProcessorInfoResp"></a>
|
||
<a id="tocSgetprocessorinforesp"></a>
|
||
<a id="tocsgetprocessorinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"cpuInfo": {
|
||
"cpuVendor": "Intel",
|
||
"cpuName": "Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz",
|
||
"processorId": "BFEBFBFF000306C3",
|
||
"cpuIdentifier": "x86_64 Family 6 Model 158 Stepping 10",
|
||
"microArchitecture": "Comet Lake",
|
||
"cpu64bit": true,
|
||
"cpuVendorFreq": 3800000000,
|
||
"physicalCpus": 1,
|
||
"physicalCores": 8,
|
||
"logicalCpu": 16
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|cpuInfo|[ProcessorInfo](#schemaprocessorinfo)|false|none||处理器信息内容。<br /><p><br />包含处理器的详细信息，例如型号、核心数、线程数、架构类型等。<br />类型为{@link ProcessorInfo}。<br /></p><br />处理器信息内容，例如型号、核心数、线程数、架构类型等。|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|
||
<h2 id="tocS_ProtocolRespGetProcessorInfoResp">ProtocolRespGetProcessorInfoResp</h2>
|
||
|
||
<a id="schemaprotocolrespgetprocessorinforesp"></a>
|
||
<a id="schema_ProtocolRespGetProcessorInfoResp"></a>
|
||
<a id="tocSprotocolrespgetprocessorinforesp"></a>
|
||
<a id="tocsprotocolrespgetprocessorinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"cpuInfo": {
|
||
"cpuVendor": "Intel",
|
||
"cpuName": "Intel(R) Core(TM) i7-10700K CPU @ 3.80GHz",
|
||
"processorId": "BFEBFBFF000306C3",
|
||
"cpuIdentifier": "x86_64 Family 6 Model 158 Stepping 10",
|
||
"microArchitecture": "Comet Lake",
|
||
"cpu64bit": true,
|
||
"cpuVendorFreq": 3800000000,
|
||
"physicalCpus": 1,
|
||
"physicalCores": 8,
|
||
"logicalCpu": 16
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[GetProcessorInfoResp](#schemagetprocessorinforesp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|
||
<h2 id="tocS_HwFirmware">HwFirmware</h2>
|
||
|
||
<a id="schemahwfirmware"></a>
|
||
<a id="schema_HwFirmware"></a>
|
||
<a id="tocShwfirmware"></a>
|
||
<a id="tocshwfirmware"></a>
|
||
|
||
```json
|
||
{
|
||
"name": "CPU固件",
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"releaseDate": "2025-01-01",
|
||
"description": "这是固件的描述信息"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|name|string|false|none||固件名称。<br /><p><br />表示固件的完整名称，例如 "CPU固件"。<br /></p><br />固件名称，用于标识具体固件。|
|
||
|version|string|false|none||固件版本。<br /><p><br />表示固件的版本号，例如 "1.0.0"。<br /></p><br />固件的版本号。|
|
||
|manufacturer|string|false|none||制造商名称。<br /><p><br />表示固件的制造商或开发公司，例如 "公司XYZ"。<br /></p><br />固件制造商的名称。|
|
||
|releaseDate|string|false|none||固件发布日期。<br /><p><br />表示固件的发布时间，使用 ISO 8601 格式的日期字符串，例如 "2025-01-01"。<br /></p><br />固件的发布日期，格式为YYYY-MM-DD。|
|
||
|description|string|false|none||固件描述。<br /><p><br />描述固件的详细信息，例如用途或特性。<br /></p><br />固件的详细描述信息。|
|
||
|
||
<h2 id="tocS_HwMotherBoard">HwMotherBoard</h2>
|
||
|
||
<a id="schemahwmotherboard"></a>
|
||
<a id="schema_HwMotherBoard"></a>
|
||
<a id="tocShwmotherboard"></a>
|
||
<a id="tocshwmotherboard"></a>
|
||
|
||
```json
|
||
{
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"model": "主板型号A",
|
||
"serialNumber": "MB123456789"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|version|string|false|none||主板版本号。<br /><p><br />表示主板的版本，例如 "1.0.0"。<br /></p><br />主板的版本号。|
|
||
|manufacturer|string|false|none||主板制造商。<br /><p><br />表示主板的制造商名称，例如 "公司XYZ"。<br /></p><br />主板的制造商名称。|
|
||
|model|string|false|none||主板型号名称。<br /><p><br />表示主板的型号，例如 "主板型号A"。<br /></p><br />主板的型号名称。|
|
||
|serialNumber|string|false|none||主板序列号。<br /><p><br />表示主板的唯一序列号，例如 "MB123456789"。<br /></p><br />主板的序列号。|
|
||
|
||
<h2 id="tocS_MemoryDetails">MemoryDetails</h2>
|
||
|
||
<a id="schemamemorydetails"></a>
|
||
<a id="schema_MemoryDetails"></a>
|
||
<a id="tocSmemorydetails"></a>
|
||
<a id="tocsmemorydetails"></a>
|
||
|
||
```json
|
||
{
|
||
"totalMemory": 0,
|
||
"freeMemory": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|totalMemory|integer(int64)|false|none||总内存大小（单位：字节）。<br /><p><br />该字段记录系统的总内存容量，通常表示物理内存或交换内存的总大小。<br />在 JSON 序列化时，通过{@link AutoExternString} 注解生成一个格式化后的额外字段。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code 8192L}（表示 8 KB 总内存）。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "totalMemory": 8192,<br /> "totalMemoryStr": "8 KB"<br />}<br /></pre>|
|
||
|freeMemory|integer(int64)|false|none||空闲内存大小（单位：字节）。<br /><p><br />该字段记录系统当前可用的内存大小，通常用于监控系统运行时内存的利用率。<br />在 JSON 序列化时，通过{@link AutoExternString} 注解生成一个格式化后的额外字段。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code 2048L}（表示 2 KB 空闲内存）。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "freeMemory": 2048,<br /> "freeMemoryStr": "2 KB"<br />}<br /></pre>|
|
||
|
||
<h2 id="tocS_HwMemory">HwMemory</h2>
|
||
|
||
<a id="schemahwmemory"></a>
|
||
<a id="schema_HwMemory"></a>
|
||
<a id="tocShwmemory"></a>
|
||
<a id="tocshwmemory"></a>
|
||
|
||
```json
|
||
{
|
||
"bankLabel": "DIMM0",
|
||
"capacity": 8192,
|
||
"clockSpeed": 2666,
|
||
"manufacturer": "Samsung",
|
||
"memoryType": "DDR4",
|
||
"partNumber": "M378A1G43AB2-CWE",
|
||
"serialNumber": "123456789ABC"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|bankLabel|string|false|none||内存模块的插槽标签。<br /><p><br />用于标识内存条安装在哪个插槽中，例如{@code "DIMM0"} 或{@code "ChannelA-DIMM1"}。<br /></p><br />内存模块的插槽标签。|
|
||
|capacity|integer(int64)|false|none||内存模块的容量（单位：字节）。<br /><p><br />表示该内存条的总容量。例如：{@code 8192L} 表示 8 GB。<br /></p><br />内存模块的容量（单位：字节）。|
|
||
|clockSpeed|integer(int64)|false|none||内存模块的时钟频率（单位：MHz）。<br /><p><br />表示内存条的运行速度，例如{@code 2666L} 表示 2666 MHz。<br /></p><br />内存模块的时钟频率（单位：MHz）。|
|
||
|manufacturer|string|false|none||内存模块的制造商。<br /><p><br />表示内存生产商的名称，例如{@code "Samsung"} 或{@code "Kingston"}。<br /></p><br />内存模块的制造商。|
|
||
|memoryType|string|false|none||内存模块的类型。<br /><p><br />表示内存的技术类型，例如{@code "DDR4"}、{@code "DDR3"} 或{@code "LPDDR4"}。<br /></p><br />内存模块的类型。|
|
||
|partNumber|string|false|none||内存模块的零件编号。<br /><p><br />用于标识内存模块的具体型号，例如{@code "M378A1G43AB2-CWE"}。<br /></p><br />内存模块的零件编号。|
|
||
|serialNumber|string|false|none||内存模块的序列号。<br /><p><br />表示内存条的唯一标识符，例如{@code "123456789ABC"}。<br /></p><br />内存模块的序列号。|
|
||
|
||
<h2 id="tocS_MemoryInfo">MemoryInfo</h2>
|
||
|
||
<a id="schemamemoryinfo"></a>
|
||
<a id="schema_MemoryInfo"></a>
|
||
<a id="tocSmemoryinfo"></a>
|
||
<a id="tocsmemoryinfo"></a>
|
||
|
||
```json
|
||
{
|
||
"physicalMemory": "8192",
|
||
"swapMemory": "8192",
|
||
"hwMemory": "8192"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|physicalMemory|[MemoryDetails](#schemamemorydetails)|false|none||物理内存的详细信息。<br /><p><br />包括总内存大小、已用内存、可用内存等属性信息。<br /></p><br />物理内存的详细信息。|
|
||
|swapMemory|[MemoryDetails](#schemamemorydetails)|false|none||物理内存的详细信息。<br /><p><br />包括总内存大小、已用内存、可用内存等属性信息。<br /></p><br />物理内存的详细信息。|
|
||
|hwMemory|[[HwMemory](#schemahwmemory)]|false|none||硬件内存的列表。<br /><p><br />包含系统中的所有内存模块的硬件信息，例如每条内存的容量、制造商等。<br /></p><br />硬件内存的列表。|
|
||
|
||
<h2 id="tocS_FileStoreDetails">FileStoreDetails</h2>
|
||
|
||
<a id="schemafilestoredetails"></a>
|
||
<a id="schema_FileStoreDetails"></a>
|
||
<a id="tocSfilestoredetails"></a>
|
||
<a id="tocsfilestoredetails"></a>
|
||
|
||
```json
|
||
{
|
||
"name": "Local Disk C:",
|
||
"volume": "Volume1234",
|
||
"mountPoint": "C:\\",
|
||
"uuid": "123e4567-e89b-12d3-a456-426614174000",
|
||
"fsType": "NTFS",
|
||
"description": "Primary System Partition",
|
||
"freeSpace": 2147483648,
|
||
"totalSpace": 10737418240,
|
||
"usableSpace": 20634418240
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|name|string|false|none||文件存储设备的名称。<br /><p><br />例如 "Local Disk C:" 或其他自定义的存储设备名称。<br /></p><br />文件存储设备的名称。|
|
||
|volume|string|false|none||存储设备的卷标。<br /><p><br />表示存储设备的逻辑卷标，例如 "Volume1234"。<br /></p><br />存储设备的卷标。|
|
||
|mountPoint|string|false|none||挂载点路径。<br /><p><br />表示存储设备在系统中的挂载路径。例如，在 Windows 系统中为 "C:\\"，在 Linux 系统中为 "/mnt/data"。<br /></p><br />挂载点路径。|
|
||
|uuid|string|false|none||存储设备的唯一标识符（UUID）。<br /><p><br />该字段通常用于标识存储设备的唯一性，例如 "123e4567-e89b-12d3-a456-426614174000"。<br /></p><br />存储设备的唯一标识符（UUID）。|
|
||
|fsType|string|false|none||文件系统类型。<br /><p><br />例如 "NTFS"、"FAT32"、"ext4" 等文件系统类型。<br /></p><br />文件系统类型。|
|
||
|description|string|false|none||存储设备的描述信息。<br /><p><br />通常用于备注存储设备的用途或特性，例如 "Primary System Partition" 表示系统主分区。<br /></p><br />存储设备的描述信息。|
|
||
|freeSpace|integer(int64)|false|none||存储设备的空闲空间大小（单位：字节）。<br /><p><br />表示当前存储设备中的剩余可用空间。<br />在 JSON 序列化时，通过{@link AutoExternString} 注解生成附加的格式化字段{@code freeSpaceStr}。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code 2147483648L}（表示 2 GB 空闲空间）。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "freeSpace": 2147483648,<br /> "freeSpaceStr": "2 GB"<br />}<br /></pre><br />存储设备的空闲空间大小（单位：字节）。|
|
||
|totalSpace|integer(int64)|false|none||存储设备的总空间大小（单位：字节）。<br /><p><br />表示存储设备的容量总大小。<br />在 JSON 序列化时，通过{@link AutoExternString} 注解生成附加的格式化字段{@code totalSpaceStr}。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code 10737418240L}（表示 10 GB 总空间）。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "totalSpace": 10737418240,<br /> "totalSpaceStr": "10 GB"<br />}<br /></pre><br />存储设备的总空间大小（单位：字节）。|
|
||
|usableSpace|integer(int64)|false|none||存储设备的可用空间大小（单位：字节）。<br /><p><br />表示当前存储设备中实际可用的空间大小，通常根据用户权限计算。<br />在 JSON 序列化时，通过{@link AutoExternString} 注解生成附加的格式化字段{@code usableSpaceStr}。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code 1073741824L}（表示 1 GB 可用空间）。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "usableSpace": 1073741824,<br /> "usableSpaceStr": "1 GB"<br />}<br /></pre><br />存储设备的可用空间大小（单位：字节）。|
|
||
|
||
<h2 id="tocS_HwDisk">HwDisk</h2>
|
||
|
||
<a id="schemahwdisk"></a>
|
||
<a id="schema_HwDisk"></a>
|
||
<a id="tocShwdisk"></a>
|
||
<a id="tocshwdisk"></a>
|
||
|
||
```json
|
||
{
|
||
"name": "Disk 0",
|
||
"model": "Samsung SSD 970 EVO Plus",
|
||
"serial": "SN1234567890",
|
||
"size": 500107862016
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|name|string|false|none||硬盘名称。<br /><p>例如：Disk 0、sda 等。</p><br />硬盘名称，例如：Disk 0、sda 等|
|
||
|model|string|false|none||硬盘型号。<br /><p>例如：Samsung SSD 970 EVO Plus。</p><br />硬盘型号，例如：Samsung SSD 970 EVO Plus|
|
||
|serial|string|false|none||硬盘序列号。<br /><p>用于唯一标识硬盘设备。</p><br />硬盘序列号，用于唯一标识硬盘设备|
|
||
|size|integer(int64)|false|none||硬盘总容量（单位：字节）。<br /><p><br />通过{@link AutoExternString} 注解使用{@link UtilsFormatType#FORMAT_BYTES} 格式化。<br />序列化时会将字节大小自动格式化为更加易读的字符串表示（如 KB、MB、GB）。<br /></p><br />硬盘总容量（单位：字节），格式化为易读的字符串表示（如 KB、MB、GB）|
|
||
|
||
<h2 id="tocS_FileStoreInfo">FileStoreInfo</h2>
|
||
|
||
<a id="schemafilestoreinfo"></a>
|
||
<a id="schema_FileStoreInfo"></a>
|
||
<a id="tocSfilestoreinfo"></a>
|
||
<a id="tocsfilestoreinfo"></a>
|
||
|
||
```json
|
||
{
|
||
"fileStore": [
|
||
{
|
||
"name": "Local Disk C:",
|
||
"volume": "Volume1234",
|
||
"mountPoint": "C:\\",
|
||
"uuid": "123e4567-e89b-12d3-a456-426614174000",
|
||
"fsType": "NTFS",
|
||
"description": "Primary System Partition",
|
||
"freeSpace": 2147483648,
|
||
"totalSpace": 10737418240,
|
||
"usableSpace": 20634418240
|
||
}
|
||
],
|
||
"hwDisk": [
|
||
{
|
||
"name": "Disk 0",
|
||
"model": "Samsung SSD 970 EVO Plus",
|
||
"serial": "SN1234567890",
|
||
"size": 500107862016
|
||
}
|
||
]
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|fileStore|[[FileStoreDetails](#schemafilestoredetails)]|false|none||文件存储详情的列表。<br /><p>每个元素表示一个文件存储的详细信息，包括挂载点、文件系统类型、总大小等。</p><br />文件存储详情的列表，每个元素表示一个文件存储的详细信息，包括挂载点、文件系统类型、总大小等|
|
||
|hwDisk|[[HwDisk](#schemahwdisk)]|false|none||硬盘信息的列表。<br /><p>每个元素表示一个硬盘设备的详细信息，包括名称、容量、序列号等。</p><br />硬盘信息的列表，每个元素表示一个硬盘设备的详细信息，包括名称、容量、序列号等|
|
||
|
||
<h2 id="tocS_IfInterfaceInfo">IfInterfaceInfo</h2>
|
||
|
||
<a id="schemaifinterfaceinfo"></a>
|
||
<a id="schema_IfInterfaceInfo"></a>
|
||
<a id="tocSifinterfaceinfo"></a>
|
||
<a id="tocsifinterfaceinfo"></a>
|
||
|
||
```json
|
||
{
|
||
"index": 1,
|
||
"name": "eth0",
|
||
"dispayName": "Ethernet Adapter",
|
||
"mac": "00:1A:2B:3C:4D:5E",
|
||
"ipv4": "[\"192.168.1.1\", \"10.0.0.1\"]",
|
||
"ipv6": "[\"fe80::1\", \"::1\"]",
|
||
"ifOperStatus": 1,
|
||
"mtu": 1500,
|
||
"speed": 1000000000,
|
||
"bytesRecv": 10485760,
|
||
"bytesSent": 20971520,
|
||
"packetsRecv": 1000,
|
||
"packetsSent": 1200,
|
||
"inErrors": 5,
|
||
"outErrors": 3,
|
||
"inDrops": 2
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|index|integer|false|none||网络接口的索引。<br />网络接口的索引|
|
||
|name|string|false|none||网络接口的名称。<br />网络接口的名称|
|
||
|dispayName|string|false|none||网络接口的显示名称。<br />网络接口的显示名称|
|
||
|mac|string|false|none||网络接口的 MAC 地址。<br />网络接口的 MAC 地址|
|
||
|ipv4|[string]|false|none||网络接口的 IPv4 地址列表。<br />网络接口的 IPv4 地址列表|
|
||
|ipv6|[string]|false|none||网络接口的 IPv6 地址列表。<br />网络接口的 IPv6 地址列表|
|
||
|ifOperStatus|integer|false|none||网络接口的运行状态。<br /><p>枚举类型：{@link NetworkIF.IfOperStatus}</p><br />网络接口的运行状态，枚举类型：UP, DOWN, UNKNOWN 等|
|
||
|mtu|integer(int64)|false|none||网络接口的最大传输单元（MTU）。<br />网络接口的最大传输单元（MTU）|
|
||
|speed|integer(int64)|false|none||网络接口的速度（单位：位/秒）。<br />网络接口的速度（单位：位/秒），格式化为易读的字符串|
|
||
|bytesRecv|integer(int64)|false|none||接收到的字节总数。<br />接收到的字节总数，格式化为易读的字符串|
|
||
|bytesSent|integer(int64)|false|none||发送的字节总数。<br />发送的字节总数，格式化为易读的字符串|
|
||
|packetsRecv|integer(int64)|false|none||接收到的报文总数。<br />接收到的报文总数，格式化为易读的字符串|
|
||
|packetsSent|integer(int64)|false|none||发送的报文总数。<br />发送的报文总数，格式化为易读的字符串|
|
||
|inErrors|integer(int64)|false|none||输入错误帧总数。<br />输入错误帧总数|
|
||
|outErrors|integer(int64)|false|none||输出错误帧总数。<br />输出错误帧总数|
|
||
|inDrops|integer(int64)|false|none||丢弃的输入数据包总数。<br />丢弃的输入数据包总数|
|
||
|
||
<h2 id="tocS_NetworkInfo">NetworkInfo</h2>
|
||
|
||
<a id="schemanetworkinfo"></a>
|
||
<a id="schema_NetworkInfo"></a>
|
||
<a id="tocSnetworkinfo"></a>
|
||
<a id="tocsnetworkinfo"></a>
|
||
|
||
```json
|
||
{
|
||
"ifNetwork": [
|
||
{
|
||
"index": 1,
|
||
"name": "eth0",
|
||
"dispayName": "Ethernet Adapter",
|
||
"mac": "00:1A:2B:3C:4D:5E",
|
||
"ipv4": "[\"192.168.1.1\", \"10.0.0.1\"]",
|
||
"ipv6": "[\"fe80::1\", \"::1\"]",
|
||
"ifOperStatus": 1,
|
||
"mtu": 1500,
|
||
"speed": 1000000000,
|
||
"bytesRecv": 10485760,
|
||
"bytesSent": 20971520,
|
||
"packetsRecv": 1000,
|
||
"packetsSent": 1200,
|
||
"inErrors": 5,
|
||
"outErrors": 3,
|
||
"inDrops": 2
|
||
}
|
||
],
|
||
"hostName": "string",
|
||
"domainName": "string",
|
||
"dnsServers": [
|
||
"string"
|
||
],
|
||
"ipv4DefaultGateway": "string",
|
||
"ipv6DefaultGateway": "string"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ifNetwork|[[IfInterfaceInfo](#schemaifinterfaceinfo)]|false|none||系统中所有的网络接口信息。<br />系统中所有的网络接口信息|
|
||
|hostName|string|false|none||系统的主机名。<br />系统的主机名|
|
||
|domainName|string|false|none||系统所在的域名。<br />系统所在的域名|
|
||
|dnsServers|[string]|false|none||系统配置的 DNS 服务器地址列表。<br />系统配置的 DNS 服务器地址列表|
|
||
|ipv4DefaultGateway|string|false|none||系统的 IPv4 默认网关地址。<br />系统的 IPv4 默认网关地址|
|
||
|ipv6DefaultGateway|string|false|none||系统的 IPv6 默认网关地址。<br />系统的 IPv6 默认网关地址|
|
||
|
||
<h2 id="tocS_HwInfo">HwInfo</h2>
|
||
|
||
<a id="schemahwinfo"></a>
|
||
<a id="schema_HwInfo"></a>
|
||
<a id="tocShwinfo"></a>
|
||
<a id="tocshwinfo"></a>
|
||
|
||
```json
|
||
{
|
||
"model": "设备型号A",
|
||
"manufacturer": "公司XYZ",
|
||
"uuid": "123e4567-e89b-12d3-a456-426655440000",
|
||
"serialNumber": "SN123456789",
|
||
"firmware": {
|
||
"name": "CPU固件",
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"releaseDate": "2025-01-01",
|
||
"description": "这是固件的描述信息"
|
||
},
|
||
"mb": {
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"model": "主板型号A",
|
||
"serialNumber": "MB123456789"
|
||
},
|
||
"memoryInfo": {
|
||
"physicalMemory": "8192",
|
||
"swapMemory": "8192",
|
||
"hwMemory": "8192"
|
||
},
|
||
"fileStoreInfo": {
|
||
"fileStore": [
|
||
{
|
||
"name": "Local Disk C:",
|
||
"volume": "Volume1234",
|
||
"mountPoint": "C:\\",
|
||
"uuid": "123e4567-e89b-12d3-a456-426614174000",
|
||
"fsType": "NTFS",
|
||
"description": "Primary System Partition",
|
||
"freeSpace": 2147483648,
|
||
"totalSpace": 10737418240,
|
||
"usableSpace": 20634418240
|
||
}
|
||
],
|
||
"hwDisk": [
|
||
{
|
||
"name": "Disk 0",
|
||
"model": "Samsung SSD 970 EVO Plus",
|
||
"serial": "SN1234567890",
|
||
"size": 500107862016
|
||
}
|
||
]
|
||
},
|
||
"networkInfo": {
|
||
"ifNetwork": [
|
||
{
|
||
"index": 1,
|
||
"name": "eth0",
|
||
"dispayName": "Ethernet Adapter",
|
||
"mac": "00:1A:2B:3C:4D:5E",
|
||
"ipv4": "[\"192.168.1.1\", \"10.0.0.1\"]",
|
||
"ipv6": "[\"fe80::1\", \"::1\"]",
|
||
"ifOperStatus": 1,
|
||
"mtu": 1500,
|
||
"speed": 1000000000,
|
||
"bytesRecv": 10485760,
|
||
"bytesSent": 20971520,
|
||
"packetsRecv": 1000,
|
||
"packetsSent": 1200,
|
||
"inErrors": 5,
|
||
"outErrors": 3,
|
||
"inDrops": 2
|
||
}
|
||
],
|
||
"hostName": "string",
|
||
"domainName": "string",
|
||
"dnsServers": [
|
||
"string"
|
||
],
|
||
"ipv4DefaultGateway": "string",
|
||
"ipv6DefaultGateway": "string"
|
||
}
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|model|string|false|none||硬件型号名称。<br /><p><br />该字段记录硬件的型号名称，通常用于标识不同的硬件设备。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code "设备型号A"}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "model": "设备型号A"<br />}<br /></pre><br />硬件型号名称。|
|
||
|manufacturer|string|false|none||硬件制造商的名称。<br /><p><br />该字段记录硬件制造商的名称，通常用于标识硬件的生产厂商。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code "公司XYZ"}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "manufacturer": "公司XYZ"<br />}<br /></pre><br />硬件制造商的名称。|
|
||
|uuid|string|false|none||硬件的唯一标识符 (UUID)。<br /><p><br />该字段记录硬件的唯一标识符，通常用于标识硬件的唯一性。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code "123e4567-e89b-12d3-a456-426655440000"}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "uuid": "123e4567-e89b-12d3-a456-426655440000"<br />}<br /></pre><br />硬件的唯一标识符 (UUID)。|
|
||
|serialNumber|string|false|none||硬件的序列号。<br /><p><br />该字段记录硬件的序列号，通常用于标识硬件的生产批次和唯一性。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code "SN123456789"}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "serialNumber": "SN123456789"<br />}<br /></pre><br />硬件的序列号。|
|
||
|firmware|[HwFirmware](#schemahwfirmware)|false|none||硬件的固件信息，包括固件名称、版本、制造商等。<br /><p><br />该字段记录硬件的固件信息，通常用于标识硬件的固件版本和制造商。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new HwFirmware()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "firmware":{...}<br />}<br /></pre><br />硬件的固件信息，包括固件名称、版本、制造商等。|
|
||
|mb|[HwMotherBoard](#schemahwmotherboard)|false|none||硬件的主板信息，包括主板型号、芯片组、制造商等。<br /><p><br />该字段记录硬件的主板信息，通常用于标识硬件的主板型号和制造商。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new HwMotherBoard()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "mb":{...}<br />}<br /></pre><br />硬件的主板信息，包括主板型号、芯片组、制造商等。|
|
||
|memoryInfo|[MemoryInfo](#schemamemoryinfo)|false|none||系统内存详细信息，包括物理内存、虚拟内存、厂商、规格等。<br /><p><br />该字段记录系统内存的详细信息，通常用于标识系统内存的容量和制造商。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new MemoryInfo()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "memoryInfo":{...}<br />}<br /></pre><br />系统内存详细信息，包括物理内存、虚拟内存、厂商、规格等。|
|
||
|fileStoreInfo|[FileStoreInfo](#schemafilestoreinfo)|false|none||文件存储设备的信息，包括挂载点、文件系统类型、容量及剩余空间。<br /><p><br />该字段记录文件存储设备的信息，通常用于标识文件存储设备的容量和文件系统类型。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new FileStoreInfo()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "fileStoreInfo":{...}<br />}<br /></pre><br />文件存储设备的信息，包括挂载点、文件系统类型、容量及剩余空间。|
|
||
|networkInfo|[NetworkInfo](#schemanetworkinfo)|false|none||网络信息。<br /><p><br />该字段记录网络的详细信息，包括网络名称、网络类型、网络状态、网络速度等。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new NetworkInfo()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "networkInfo":{...}<br />}<br /></pre>|
|
||
|
||
<h2 id="tocS_GetHwInfoResp">GetHwInfoResp</h2>
|
||
|
||
<a id="schemagethwinforesp"></a>
|
||
<a id="schema_GetHwInfoResp"></a>
|
||
<a id="tocSgethwinforesp"></a>
|
||
<a id="tocsgethwinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"hwInfo": {
|
||
"model": "设备型号A",
|
||
"manufacturer": "公司XYZ",
|
||
"uuid": "123e4567-e89b-12d3-a456-426655440000",
|
||
"serialNumber": "SN123456789",
|
||
"firmware": {
|
||
"name": "CPU固件",
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"releaseDate": "2025-01-01",
|
||
"description": "这是固件的描述信息"
|
||
},
|
||
"mb": {
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"model": "主板型号A",
|
||
"serialNumber": "MB123456789"
|
||
},
|
||
"memoryInfo": {
|
||
"physicalMemory": "8192",
|
||
"swapMemory": "8192",
|
||
"hwMemory": "8192"
|
||
},
|
||
"fileStoreInfo": {
|
||
"fileStore": [
|
||
{
|
||
"name": "[",
|
||
"volume": "[",
|
||
"mountPoint": "[",
|
||
"uuid": "[",
|
||
"fsType": "[",
|
||
"description": "[",
|
||
"freeSpace": "[",
|
||
"totalSpace": "[",
|
||
"usableSpace": "["
|
||
}
|
||
],
|
||
"hwDisk": [
|
||
{
|
||
"name": "[",
|
||
"model": "[",
|
||
"serial": "[",
|
||
"size": "["
|
||
}
|
||
]
|
||
},
|
||
"networkInfo": {
|
||
"ifNetwork": [
|
||
{
|
||
"index": "[",
|
||
"name": "[",
|
||
"dispayName": "[",
|
||
"mac": "[",
|
||
"ipv4": "[",
|
||
"ipv6": "[",
|
||
"ifOperStatus": "[",
|
||
"mtu": "[",
|
||
"speed": "[",
|
||
"bytesRecv": "[",
|
||
"bytesSent": "[",
|
||
"packetsRecv": "[",
|
||
"packetsSent": "[",
|
||
"inErrors": "[",
|
||
"outErrors": "[",
|
||
"inDrops": "["
|
||
}
|
||
],
|
||
"hostName": "string",
|
||
"domainName": "string",
|
||
"dnsServers": [
|
||
"string"
|
||
],
|
||
"ipv4DefaultGateway": "string",
|
||
"ipv6DefaultGateway": "string"
|
||
}
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|hwInfo|[HwInfo](#schemahwinfo)|false|none||硬件信息内容。<br /><p><br />包含系统的硬件配置信息，例如 CPU 型号、内存大小、存储容量和操作系统版本等。<br />类型为{@link HwInfo}。<br /></p><br />硬件信息内容，例如 CPU 型号、内存大小、存储容量和操作系统版本|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|
||
<h2 id="tocS_ProtocolRespGetHwInfoResp">ProtocolRespGetHwInfoResp</h2>
|
||
|
||
<a id="schemaprotocolrespgethwinforesp"></a>
|
||
<a id="schema_ProtocolRespGetHwInfoResp"></a>
|
||
<a id="tocSprotocolrespgethwinforesp"></a>
|
||
<a id="tocsprotocolrespgethwinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"hwInfo": {
|
||
"model": "设备型号A",
|
||
"manufacturer": "公司XYZ",
|
||
"uuid": "123e4567-e89b-12d3-a456-426655440000",
|
||
"serialNumber": "SN123456789",
|
||
"firmware": {
|
||
"name": "CPU固件",
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"releaseDate": "2025-01-01",
|
||
"description": "这是固件的描述信息"
|
||
},
|
||
"mb": {
|
||
"version": "1.0.0",
|
||
"manufacturer": "公司XYZ",
|
||
"model": "主板型号A",
|
||
"serialNumber": "MB123456789"
|
||
},
|
||
"memoryInfo": {
|
||
"physicalMemory": "8192",
|
||
"swapMemory": "8192",
|
||
"hwMemory": "8192"
|
||
},
|
||
"fileStoreInfo": {
|
||
"fileStore": [
|
||
{}
|
||
],
|
||
"hwDisk": [
|
||
{}
|
||
]
|
||
},
|
||
"networkInfo": {
|
||
"ifNetwork": [
|
||
{}
|
||
],
|
||
"hostName": "string",
|
||
"domainName": "string",
|
||
"dnsServers": [
|
||
"string"
|
||
],
|
||
"ipv4DefaultGateway": "string",
|
||
"ipv6DefaultGateway": "string"
|
||
}
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[GetHwInfoResp](#schemagethwinforesp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|
||
<h2 id="tocS_GetNetworkInfoResp">GetNetworkInfoResp</h2>
|
||
|
||
<a id="schemagetnetworkinforesp"></a>
|
||
<a id="schema_GetNetworkInfoResp"></a>
|
||
<a id="tocSgetnetworkinforesp"></a>
|
||
<a id="tocsgetnetworkinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"networkInfo": {
|
||
"ifNetwork": [
|
||
{
|
||
"index": 1,
|
||
"name": "eth0",
|
||
"dispayName": "Ethernet Adapter",
|
||
"mac": "00:1A:2B:3C:4D:5E",
|
||
"ipv4": "[\"192.168.1.1\", \"10.0.0.1\"]",
|
||
"ipv6": "[\"fe80::1\", \"::1\"]",
|
||
"ifOperStatus": 1,
|
||
"mtu": 1500,
|
||
"speed": 1000000000,
|
||
"bytesRecv": 10485760,
|
||
"bytesSent": 20971520,
|
||
"packetsRecv": 1000,
|
||
"packetsSent": 1200,
|
||
"inErrors": 5,
|
||
"outErrors": 3,
|
||
"inDrops": 2
|
||
}
|
||
],
|
||
"hostName": "string",
|
||
"domainName": "string",
|
||
"dnsServers": [
|
||
"string"
|
||
],
|
||
"ipv4DefaultGateway": "string",
|
||
"ipv6DefaultGateway": "string"
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|networkInfo|[NetworkInfo](#schemanetworkinfo)|false|none||网络信息。<br /><p><br />该字段记录网络的详细信息，包括网络名称、网络类型、网络状态、网络速度等。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new NetworkInfo()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "networkInfo":{...}<br />}<br /></pre>|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|
||
<h2 id="tocS_ProtocolRespGetNetworkInfoResp">ProtocolRespGetNetworkInfoResp</h2>
|
||
|
||
<a id="schemaprotocolrespgetnetworkinforesp"></a>
|
||
<a id="schema_ProtocolRespGetNetworkInfoResp"></a>
|
||
<a id="tocSprotocolrespgetnetworkinforesp"></a>
|
||
<a id="tocsprotocolrespgetnetworkinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"networkInfo": {
|
||
"ifNetwork": [
|
||
{
|
||
"index": "[",
|
||
"name": "[",
|
||
"dispayName": "[",
|
||
"mac": "[",
|
||
"ipv4": "[",
|
||
"ipv6": "[",
|
||
"ifOperStatus": "[",
|
||
"mtu": "[",
|
||
"speed": "[",
|
||
"bytesRecv": "[",
|
||
"bytesSent": "[",
|
||
"packetsRecv": "[",
|
||
"packetsSent": "[",
|
||
"inErrors": "[",
|
||
"outErrors": "[",
|
||
"inDrops": "["
|
||
}
|
||
],
|
||
"hostName": "string",
|
||
"domainName": "string",
|
||
"dnsServers": [
|
||
"string"
|
||
],
|
||
"ipv4DefaultGateway": "string",
|
||
"ipv6DefaultGateway": "string"
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[GetNetworkInfoResp](#schemagetnetworkinforesp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|
||
<h2 id="tocS_GetMemoryInfoResp">GetMemoryInfoResp</h2>
|
||
|
||
<a id="schemagetmemoryinforesp"></a>
|
||
<a id="schema_GetMemoryInfoResp"></a>
|
||
<a id="tocSgetmemoryinforesp"></a>
|
||
<a id="tocsgetmemoryinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"memoryInfo": {
|
||
"physicalMemory": "8192",
|
||
"swapMemory": "8192",
|
||
"hwMemory": "8192"
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|memoryInfo|[MemoryInfo](#schemamemoryinfo)|false|none||系统内存详细信息，包括物理内存、虚拟内存、厂商、规格等。<br /><p><br />该字段记录系统内存的详细信息，通常用于标识系统内存的容量和制造商。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new MemoryInfo()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "memoryInfo":{...}<br />}<br /></pre><br />系统内存详细信息，包括物理内存、虚拟内存、厂商、规格等。|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|
||
<h2 id="tocS_ProtocolRespGetMemoryInfoResp">ProtocolRespGetMemoryInfoResp</h2>
|
||
|
||
<a id="schemaprotocolrespgetmemoryinforesp"></a>
|
||
<a id="schema_ProtocolRespGetMemoryInfoResp"></a>
|
||
<a id="tocSprotocolrespgetmemoryinforesp"></a>
|
||
<a id="tocsprotocolrespgetmemoryinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"memoryInfo": {
|
||
"physicalMemory": "8192",
|
||
"swapMemory": "8192",
|
||
"hwMemory": "8192"
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[GetMemoryInfoResp](#schemagetmemoryinforesp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|
||
<h2 id="tocS_GetFileStoreInfoResp">GetFileStoreInfoResp</h2>
|
||
|
||
<a id="schemagetfilestoreinforesp"></a>
|
||
<a id="schema_GetFileStoreInfoResp"></a>
|
||
<a id="tocSgetfilestoreinforesp"></a>
|
||
<a id="tocsgetfilestoreinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"fileStoreInfo": {
|
||
"fileStore": [
|
||
{
|
||
"name": "Local Disk C:",
|
||
"volume": "Volume1234",
|
||
"mountPoint": "C:\\",
|
||
"uuid": "123e4567-e89b-12d3-a456-426614174000",
|
||
"fsType": "NTFS",
|
||
"description": "Primary System Partition",
|
||
"freeSpace": 2147483648,
|
||
"totalSpace": 10737418240,
|
||
"usableSpace": 20634418240
|
||
}
|
||
],
|
||
"hwDisk": [
|
||
{
|
||
"name": "Disk 0",
|
||
"model": "Samsung SSD 970 EVO Plus",
|
||
"serial": "SN1234567890",
|
||
"size": 500107862016
|
||
}
|
||
]
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|fileStoreInfo|[FileStoreInfo](#schemafilestoreinfo)|false|none||文件存储设备的信息，包括挂载点、文件系统类型、容量及剩余空间。<br /><p><br />该字段记录文件存储设备的信息，通常用于标识文件存储设备的容量和文件系统类型。<br />在 JSON 序列化时，该字段直接输出原始值。<br /></p><br /><br /><p><b>示例值：</b></p><br /><ul><br /> <li>{@code new FileStoreInfo()}。</li><br /></ul><br /><br /><p><b>JSON 输出示例：</b></p><br /><pre><br />{<br /> "fileStoreInfo":{...}<br />}<br /></pre><br />文件存储设备的信息，包括挂载点、文件系统类型、容量及剩余空间。|
|
||
|status|integer|false|none||响应状态码。<br /><p><br />表示接口调用的执行状态，默认值为{@code ErrorCode.ERR_OK.getCode()}，即操作成功。<br />可以通过{@link ErrorCode} 枚举类获取所有状态码。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>0：操作成功。</li><br /> <li>1：操作失败。</li><br /> <li>400：请求参数错误。</li><br /></ul><br /></p><br />响应状态码。0表示成功，其他值表示失败，可参考ErrorCode类。|
|
||
|message|[string]|false|none||响应消息描述。<br /><p><br />表示接口调用的状态描述信息，支持多条消息内容。<br />默认值为{@code ErrorCode.ERR_OK.getDescription()}，即 "操作成功"。<br /></p><br /><br /><p><br />示例：<br /><ul><br /> <li>["操作成功"]</li><br /> <li>["参数错误", "字段name不能为空"]</li><br /></ul><br /></p><br />响应消息描述，支持多条消息内容。|
|
||
|
||
<h2 id="tocS_ProtocolRespGetFileStoreInfoResp">ProtocolRespGetFileStoreInfoResp</h2>
|
||
|
||
<a id="schemaprotocolrespgetfilestoreinforesp"></a>
|
||
<a id="schema_ProtocolRespGetFileStoreInfoResp"></a>
|
||
<a id="tocSprotocolrespgetfilestoreinforesp"></a>
|
||
<a id="tocsprotocolrespgetfilestoreinforesp"></a>
|
||
|
||
```json
|
||
{
|
||
"ver": 0,
|
||
"cryptoType": 0,
|
||
"timeStamp": 0,
|
||
"msgContent": {
|
||
"fileStoreInfo": {
|
||
"fileStore": [
|
||
{
|
||
"name": "[",
|
||
"volume": "[",
|
||
"mountPoint": "[",
|
||
"uuid": "[",
|
||
"fsType": "[",
|
||
"description": "[",
|
||
"freeSpace": "[",
|
||
"totalSpace": "[",
|
||
"usableSpace": "["
|
||
}
|
||
],
|
||
"hwDisk": [
|
||
{
|
||
"name": "[",
|
||
"model": "[",
|
||
"serial": "[",
|
||
"size": "["
|
||
}
|
||
]
|
||
},
|
||
"status": 0,
|
||
"message": "[\"操作成功\"]"
|
||
},
|
||
"code": 0
|
||
}
|
||
|
||
```
|
||
|
||
### 属性
|
||
|
||
|名称|类型|必选|约束|中文名|说明|
|
||
|---|---|---|---|---|---|
|
||
|ver|integer|false|none||协议版本号。<br /><p><br />必填字段，定义协议的版本号，用于兼容性控制。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供版本号。</li><br /> <li>值范围校验：1 到 9999。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setVer(1);<br /></pre><br /></p>|
|
||
|cryptoType|integer|false|none||加密类型。<br /><p><br />必填字段，定义协议使用的加密方式。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供加密类型。</li><br /> <li>值范围校验：0 到 4。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setCryptoType(0); // 未加密<br />protocol.setCryptoType(1); // AES 加密<br /></pre><br /></p>|
|
||
|timeStamp|integer(int64)|false|none||时间戳。<br /><p><br />必填字段，定义协议的时间戳，用于记录消息的发送时间。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>非空校验：必须提供时间戳。</li><br /> <li>自定义校验：使用{@link ValidProtocolTimestamp} 验证时间戳的合法性。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setTimeStamp(System.currentTimeMillis());<br /></pre><br /></p>|
|
||
|msgContent|[GetFileStoreInfoResp](#schemagetfilestoreinforesp)|false|none||消息内容。<br /><p><br />可选字段，表示具体的消息内容，由泛型参数{@code T} 决定其类型。<br /></p><br /><p><br />校验规则：<br /><ul><br /> <li>嵌套校验：对{@code msgContent} 内容进行校验（如果存在）。</li><br /></ul><br /></p><br /><p><br />示例：<br /><pre><br />protocol.setMsgContent(new MyMessage());<br /></pre><br /></p>|
|
||
|code|integer|false|none||状态码。<br /><p><br />表示协议的响应状态码，例如 HTTP 状态码（200 表示成功，400 表示请求错误等）。<br /></p><br />状态码，例如：200 表示成功，400 表示请求错误|
|
||
|