Documentation
角色 object
以下 objects 直接与 role API 相关。
角色
角色 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| roleid | ID | 角色的ID。 属性行为: - 只读 - 在 update 操作中为必填 |
| name | string | 角色的名称。 属性行为: - 在 create 操作中为必填 |
| type | integer | 用户类型。 可能的取值： 1 - (默认) 普通用户； 2 - 管理员； 3 - 超级管理员。 属性行为: - 在 create 操作中为必填 |
| readonly | integer | 角色是否为只读。 可能的取值： 0 - (默认) 否； 1 - 是。 属性行为: - 只读 |
角色规则
角色规则 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| ui | array | array of the ui-元素 objects。 |
| ui.default_access | integer | 是否启用对新UI元素的访问。 可能的值： 0 - 已禁用； 1 - (默认) 已启用。 |
| services.read.mode | integer | 对服务的只读访问。 可能的值： 0 - 对由 services.read.list 指定或由 services.read.tag 属性匹配的服务具有只读访问权限；1 - (默认) 对所有服务具有只读访问权限。 |
| services.read.list | array | array of 服务 objects。 指定的服务（包括子服务）将被授予用户角色的只读访问权限。只读访问权限不会覆盖对服务的读写访问权限。 属性行为: - 如果 services.read.mode 设置为 "0"，则支持 |
| services.read.tag | object | array of 服务标签 objects。 标签匹配的服务（包括子服务）将被授予用户角色的只读访问权限。只读访问权限不会覆盖对服务的读写访问权限。 属性行为: - 如果 services.read.mode 设置为 "0"，则支持 |
| services.write.mode | integer | 对服务的读写访问。 可能的值： 0 - (默认) 对由 services.write.list 指定或由 services.write.tag 属性匹配的服务具有读写访问权限；1 - 对所有服务具有读写访问权限。 |
| services.write.list | array | array of 服务 objects。 指定的服务（包括子服务）将被授予用户角色的读写访问权限。读写访问权限将覆盖对服务的只读访问权限。 属性行为: - 如果 services.write.mode 设置为 "0"，则支持 |
| services.write.tag | object | array of 服务标签 objects。 标签匹配的服务（包括子服务）将被授予用户角色的读写访问权限。读写访问权限将覆盖对服务的只读访问权限。 属性行为: - 如果 services.write.mode 设置为 "0"，则支持 |
| modules | array | array of the 模块 objects。 |
| modules.default_access | integer | 是否启用对新模块的访问。 可能的值： 0 - 已禁用； 1 - (默认) 已启用。 |
| api.access | integer | 是否启用对 API 的访问。 可能的值： 0 - 已禁用； 1 - (默认) 已启用。 |
| api.mode | integer | 处理 api 属性中列出的 API 方法的模式。可能的值： 0 - (默认) 拒绝列表； 1 - 允许列表。 |
| api | array | array of API 方法。 |
| actions | array | array of the 动作 objects。 |
| actions.default_access | integer | 是否启用对新动作的访问。 可能的值： 0 - 已禁用； 1 - (默认) 已启用。 |
UI元素
UI元素 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| name | string | UI元素的名称。 如果角色 object 的 type 设置为 "User"、"Admin" 或 "Super admin"，可能的取值如下：monitoring.dashboard - 仪表板；monitoring.problems - 监控 → 问题；monitoring.hosts - 监控 → 主机；monitoring.latest_data - 监控 → 最新数据；monitoring.maps - 监控 → 拓扑图；services.services - 服务 → 服务；services.sla_report - 服务 → SLA 报告；inventory.overview - 资产 → 概览；inventory.hosts - 资产 → 主机；reports.availability_report - 报告 → 可用性报告；reports.top_triggers - 报告 → 触发器 Top 100。如果角色 object 的 type 设置为 "Admin" 或 "Super admin"，可能的取值如下：monitoring.discovery - 监控 → 自动发现；services.sla - 服务 → SLA；reports.scheduled_reports - 报告 → 定期报告；reports.notifications - 报告 → 通知；configuration.template_groups - 数据采集 → 模板组；configuration.host_groups - 数据采集 → 主机 组；configuration.templates - 数据采集 → 模板；configuration.hosts - 数据采集 → 主机；configuration.maintenance - 数据采集 → 维护；configuration.discovery - 数据采集 → 自动发现；configuration.trigger_actions - 告警 → 动作 → 触发器动作；configuration.service_actions - 告警 → 动作 → 服务动作；configuration.discovery_actions - 告警 → 动作 → 自动发现动作；configuration.autoregistration_actions - 告警 → 动作 → 自动注册动作；configuration.internal_actions - 告警 → 动作 → 内部动作。如果角色 object 的 type 设置为 "Super admin"，可能的取值如下：reports.system_info - 报告 → 系统信息；reports.audit - 报告 → 审计日志；reports.action_log - 报告 → 动作日志；configuration.event_correlation - 数据采集 → 事件关联；administration.media_types - 告警 → 媒介类型；administration.scripts - 告警 → 脚本；administration.user_groups - 用户 → 用户组；administration.user_roles - 用户 → 用户角色；administration.users - 用户 → 用户；administration.api_tokens - 用户 → API 令牌；administration.authentication - 用户 → 认证；administration.general - 管理 → 常规；administration.audit_log - 管理 → 审计日志；administration.housekeeping - 管理 → 清理；administration.proxy_groups - 管理 → proxy 组；administration.proxies - 管理 → Proxies；administration.macros - 管理 → 宏；administration.queue - 管理 → 队列。属性行为： - 必填 |
| status | integer | 是否启用对UI元素的访问。 可能的取值： 0 - 禁用； 1 - (默认) 启用。 |
服务
服务标签
| 属性 | 数据类型 | 描述 |
|---|---|---|
| tag | string | 标签名。 如果指定为空 string，则服务标签不会用于服务匹配。 属性行为: - 必填 |
| value | string | 标签值。 如果未指定值或指定为空 string，则仅使用标签名称进行服务匹配。 |
模块
模块 object 具有以下属性：
动作
操作 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| name | string | 操作的名称。 如果角色 object 的 type 设置为 "User"、"Admin" 或 "Super admin"，可能的取值如下：edit_dashboards - 创建和编辑仪表板；edit_maps - 创建和编辑拓扑图；add_problem_comments - 添加问题评论；change_severity - 更改问题严重性；acknowledge_problems - 问题确认；suppress_problems - 抑制问题；close_problems - 关闭问题；execute_scripts - 执行脚本；manage_api_tokens - 管理 API 令牌。如果 角色 object 的 type 设置为 "Admin" 或 "Super admin"，可能的取值如下：edit_maintenance - 创建和编辑维护；manage_scheduled_reports - 管理计划报告；manage_sla - 管理 SLA。如果 角色 object 的 type 设置为 "User" 或 "Admin"，可能的取值如下：invoke_execute_now - 允许对仅具有 主机 读取权限的用户执行 execute 监控项 检查。属性行为: - 必填 |
| status | integer | 是否启用执行该操作的权限。 可能的取值： 0 - 已禁用； 1 - (默认) 已启用。 |