CSR配置字典之ObjectSync类
更新时间: 2026/11/09
在AtomGit上查看源码📋 文档信息
| 项目 | 内容 |
|---|---|
| 文档标题 | ObjectSync类配置字典 |
| 版本 | v1.0 |
| 创建日期 | 2026-11-07 |
| 最后更新 | 2026-11-07 |
| 维护状态 | ✅ 活跃维护 |
📋 变更历史记录
文档变更记录
| 版本 | 发布日期 | 变更类型 | 变更内容 | 影响范围 | 维护人员 |
|---|---|---|---|---|---|
| v1.0 | 2026-11-07 | 新增 | 按 model.json 中 usage 含 CSR 的属性新增ObjectSync类配置字典 | ObjectSync | 待补充 |
🎯 类概览
ObjectSync 类
| 属性 | 值 |
|---|---|
| 类名称 | ObjectSync |
| 功能描述 | 见属性详表 |
| 所属SIG组 | bmc-core |
| 所属组件 | bmc_datasync |
| 责任人 | 对应SIG组Committer |
| 最后更新 | 2026-11-07 |
| 状态 | 🟢 正常运行 |
- 模型未声明 required。带 default 的属性按可选处理;没有 default 的属性也暂列可选,空值是否导致初始化失败需业务确认。
- 分类按属性名归纳,未逐项对照驱动初始化,分类待确认。
- 详表只收录 usage 含 CSR 的属性。
📊 属性定义详表
模型来源:bmc_datasync/mds/model.json。字段是否可由 CSR 配置以模型的 usage 为准;接口属性的类型和描述补查 mdb_interface/json/intf 中同名接口,模型显式定义优先。
ObjectSync 类 - 必选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 | 分类 |
|---|---|---|---|---|---|---|---|---|---|
| (无) | - | - | - | - | 模型未声明 required,本类没有单独标成必选的 CSR 属性 | - | - | - | - |
ObjectSync 类 - 可选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 | 分类 |
|---|---|---|---|---|---|---|---|---|---|
ForceSync | Boolean | false | - | - | 是否绕过DataSyncAllowed;不绕过发送角色、TCP使能和目标有效性检查 | CSR 配置 | false | CSR配置 | 软件 |
WatchObject | Struct | 无 | - | - | 对象新增删除监听目标;Service和Interface必填,Path为空时监听该服务接口下全部对象 | CSR 配置 | {} | CSR配置 | 软件 |
AddedMethod | Struct | 无 | - | - | 新增事件调用的备用板RPC;业务入参由AddedParameters按顺序提供,Signature按实际方法配置;Path为空时调用事件对象路径 | CSR 配置 | {} | CSR配置 | 软件 |
AddedParameters | Array | 无 | - | - | 新增事件RPC的有序属性参数来源;空字段继承AddedMethod及本次实际调用路径;仅新增事件触发采集,不监听参数变化;空数组表示无业务参数 | CSR 配置 | [] | CSR配置 | 软件 |
RemovedMethod | Struct | 无 | - | - | 删除事件调用的备用板RPC;业务入参由RemovedParameters按顺序提供,Signature按实际方法配置;建议Path配置常驻管理对象,失败不增加业务重试 | CSR 配置 | {} | CSR配置 | 软件 |
RemovedParameters | Array | 无 | - | - | 删除事件RPC的有序属性参数来源;空字段继承RemovedMethod及本次实际调用路径;应从仍存在对象读取,任一读取失败跳过本轮,不缓存或重试;空数组表示无业务参数 | CSR 配置 | [] | CSR配置 | 软件 |
📝 配置示例
ObjectSync 对象
对象路径:模型未声明 path。以下仅演示字段结构与数据类型;对象引用、端口及数值需按目标硬件填写,不能直接作为可运行配置。
json
{
"ObjectSync_1": {
"ForceSync": false,
"WatchObject": {},
"AddedMethod": {},
"AddedParameters": [],
"RemovedMethod": {},
"RemovedParameters": []
}
}🔧 使用指南
配置步骤
- 在 CSR 的 Objects 中增加
ObjectSync对象,对象名在同一文件内保持唯一。 - 按属性详表填写需要覆盖的字段。模型里的 default 可以不写。
- 没有 default 的字段先与业务确认是否允许为空,再决定是否写入 CSR。
注意事项
- 本文只收录 usage 含 CSR 的属性。
- 模型没有 required 列表。没有 default 的属性暂放在可选属性,需业务确认。
- 配置示例中的键都能在属性详表中找到。
故障排查
- 对象没有创建:核对 CSR 里的类名是
ObjectSync。 - 属性不生效:核对 usage 是否含 CSR,类型是否与 baseType 一致。
- 引用字段报错:确认
#/指向的对象在同一份 CSR 中已经定义。