> 角色 object
以下objects与role API直接相关。
角色
角色 object 具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| roleid | string | (只读) 角色的ID。 |
| name (required) |
string | 角色的名称。 |
| type (required) |
integer | 用户类型。 可能的值： 1 - (默认) 用户； 2 - 管理员； 3 - 超级管理员。 |
| readonly | integer | (只读) 角色是否为只读。 可能的值： 0 - (默认) 否； 1 - 是。 |
请注意，对于某些方法（更新、删除），所需/可选参数的组合是不同的。
角色规则
角色规则object具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| ui | array | ui-元素objects的array。 |
| ui.default_access | integer | 是否启用对新UI元素的访问。 可能值： 0 - 禁用； 1 - （默认） 启用。 |
| services.read.mode | integer | 对服务的只读访问权限。 可能值： 0 - 对由 services.read.list指定或由services.read.tag属性匹配的服务具有只读访问权限。1 - （默认） 对所有服务具有只读访问权限。 |
| services.read.list | array | 服务objects的array。 指定的服务（包括子服务）将被授予用户角色只读访问权限。只读访问不会覆盖对服务的读写访问权限。 仅在 services.read.mode设置为0时使用。 |
| services.read.tag | object | 服务标签object的array。 标签匹配的服务（包括子服务）将被授予用户角色只读访问权限。只读访问不会覆盖对服务的读写访问权限。 仅在 services.read.mode设置为0时使用。 |
| services.write.mode | integer | 对服务的读写访问权限。 可能值： 0 - （默认）对由 services.write.list指定或由services.write.tag属性匹配的服务具有读写访问权限。1 - 对所有服务具有读写访问权限。 |
| services.write.list | array | 服务objects的array。 指定的服务（包括子服务）将被授予用户角色读写访问权限。读写访问将覆盖对服务的只读访问权限。 仅在 services.write.mode设置为0时使用。 |
| services.write.tag | object | 服务标签object的array。 标签匹配的服务（包括子服务）将被授予用户角色读写访问权限。读写访问将覆盖对服务的只读访问权限。 仅在 services.write.mode设置为0时使用。 |
| modules | array | 模块objects的array。 |
| modules.default_access | integer | 是否启用对新模块的访问。 可能值： 0 - 禁用； 1 - （默认） 启用。 |
| api.access | integer | 是否启用对API的访问。 可能值： 0 - 禁用； 1 - （默认） 启用。 |
| api.mode | integer | 处理api属性中列出的API方法的模式。可能值： 0 - （默认） 拒绝列表； 1 - 允许列表。 |
| api | array | API方法的array。 |
| actions | array | 动作objects的array。 |
| actions.default_access | integer | 是否启用对新操作的访问。 可能值： 0 - 禁用； 1 - （默认） 启用。 |
UI 元素
用户界面元素object具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| name (required) |
string | 用户界面元素的名称。 所有用户类型可用的可能值： 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。仅限管理员和超级管理员用户类型可用的可能值： monitoring.discovery - 监控 → 发现；services.actions - 服务 → 服务操作；services.sla - 服务 → SLA；reports.scheduled_reports - 报表 → 计划报表；reports.notifications - 报表 → 通知；configuration.host_groups - 配置 → 主机组；configuration.templates - 配置 → 模板；configuration.hosts - 配置 → 主机；configuration.maintenance - 配置 → 维护；configuration.actions - 配置 → 动作；configuration.discovery - 配置 → 发现。仅限超级管理员用户类型可用的可能值： reports.system_info - 报表 → 系统信息；reports.audit - 报表 → 审计；reports.action_log - 报表 → 动作日志；configuration.event_correlation - 配置 → 事件关联；administration.general - 管理 → 常规；administration.proxies - 管理 → Proxies；administration.authentication - 管理 → 认证；administration.user_groups - 管理 → 用户组；administration.user_roles - 管理 → 用户角色；administration.users - 管理 → 用户；administration.media_types - 管理 → 媒介类型；administration.scripts - 管理 → 脚本；administration.queue - 管理 → 队列。 |
| status | integer | 是否启用对用户界面元素的访问。 可能的值： 0 - 禁用； 1 - （默认） 启用。 |
服务
| 属性 | 数据类型 | 描述 |
|---|---|---|
| serviceid (required) |
string | 服务的ID。 |
服务标签
| 属性 | 数据类型 | 描述 |
|---|---|---|
| tag (required) |
string | 标签名称。 如果指定了空string，则该服务标签不会用于服务匹配。 |
| value | string | 标签值。 如果未指定值或指定了空string，则仅使用标签名称进行服务匹配。 |
模块
模块 object 具有以下属性：
| 属性 | 数据类型 | 说明 |
|---|---|---|
| moduleid (required) |
string | 模块的ID标识符。 |
| status | integer | 是否启用模块访问权限。 可选值： 0 - 禁用； 1 - （默认） 启用。 |
动作
操作object具有以下属性：
| 属性 | 数据类型 | 描述 |
|---|---|---|
| name (required) |
string | 操作名称。 所有用户类型可用的值： edit_dashboards - 创建和编辑仪表板；edit_maps - 创建和编辑地图；add_problem_comments - 添加问题评论；change_severity - 更改问题严重性；acknowledge_problems - 确认问题；close_problems - 关闭问题；execute_scripts - 执行脚本；manage_api_tokens - 管理API令牌。仅限管理员和超级管理员用户类型可用的值： edit_maintenance - 创建和编辑维护；manage_scheduled_reports - 管理计划报告；manage_sla - 管理SLA。 |
| status | integer | 是否启用执行该操作的权限。 可能的值： 0 - 禁用； 1 - (默认) 启用。 |