定时截图CA认证
上传 CA 配置接口文档
概览
用于查询和更新设备上传 CA 配置。
路由注册位置:
- /xsw/api/sys/getUploadCAConf
- /xsw/api/sys/setUploadCAConf
支持方法:
- GET
- POST
通用错误返回结构:
| 字段 | 类型 | 说明 |
|---|---|---|
| code | int32 | 成功0,错误码,失败通常为 1000 |
| msg | string | 错误信息 |
1. 获取上传 CA 配置
接口信息
- 路径:
/xsw/api/sys/getUploadCAConf - 方法:
GET/POST - 请求体:无
返回结构
成功时返回对象 UploadCAConf:
| 字段 | 类型 | 说明 |
|---|---|---|
| enable | int32 | 上传 CA 校验模式 |
| content | string | CA 文件文本内容 |
说明:
- enable 读取自配置项 syscontrol.0.upload_ca_enable。
- 当 CA 文件不存在时,content 返回空字符串。
成功示例
{
"enable": 1,
"content": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"
}
失败示例
{
"code": 1000,
"msg": "...错误原因..."
}
2. 设置上传 CA 配置
接口信息
- 路径:
/xsw/api/sys/setUploadCAConf - 方法:
GET/POST - 推荐
Content-Type:application/json
请求体
{
"enable": 1,
"content": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"
}
字段说明:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| enable | int32 | 是 | 校验模式,允许值:0、1、2、101 |
| content | string | 否 | CA 文件内容;为空字符串时不更新 CA 文件 |
参数校验规则:
- enable 仅允许 0/1/2/101,否则返回错误:enable should be 0,1,2,101。
- 请求体必须是合法 JSON,否则返回错误:invalid json body: ...。
处理逻辑
- 解析 JSON 请求体为
UploadCAConf。 - 校验
enable是否在允许范围内。 - 若
content非空,写入 CA 文件。 - 更新配置字段
syscontrol.0.upload_ca_enable。 - 持久化配置。
成功响应
{
"code": 0,
"msg": ""
}
失败响应
{
"code": 1000,
"msg": "...错误原因..."
}
3. cURL 示例
获取配置
curl -X GET "http://<host>/xsw/api/sys/getUploadCAConf"
更新配置(仅更新模式)
curl -X POST "http://<host>/xsw/api/sys/setUploadCAConf" \
-H "Content-Type: application/json" \
-d '{"enable":2,"content":""}'
更新配置(更新模式 + CA 内容)
curl -X POST "http://<host>/xsw/api/sys/setUploadCAConf" \
-H "Content-Type: application/json" \
-d '{"enable":1,"content":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"}'
这份文档没解决你的问题?联系我们,技术工程师直接对接。