角色对象
以下内容将详细介绍有关 角色 API的相关功能。
角色
一个角色对象拥有以下属性： |属性|类型|说明| |--------|---------------------------------------------------|-----------| |roleid|字符串|（只读） 角色ID号。| |name
（必要）|字符串|角色名称。| |type
(必需)|整数|用户类型。
可选值：
1 - （缺省值） 普通用户；
2 - 管理员；
3 - 超级管理员。| |readonly|整数|（只读） 设定角色是否为只读。
可选值：
0 - （缺省值） 否；
1 - 是。| 注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。
角色规则
角色规则拥有下列属性特征：
| 属性 | 类型 | 说明 |
|---|---|---|
| ui | 数组 | 一组包含UI元素 对象的数组。 |
| ui.default_access | 整数 | 表示新的UI元素状态为启动与否。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| services.read.mode | 整数 | 只允许只读性质的业务访问。 可配置的参数包括： 0 - 启动只读模式，通过 services.read.list来限定只读的业务，或者通过与services.read.tag匹配对对应业务进行访问。1 - （缺省值） 对所有业务均采用只读访问。 |
| services.read.list | 数字 | 该数组包含所有业务 对象。 列表中的业务，包含其子业务，会对目标角色用户开启只读访问。对业务来说，只读访问并不会覆盖读写访问。 只有将 services.read.mode设定为0才会开应用属性。 |
| services.read.tag | 对象 | 包含一组业务标签对象的参数。 标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。 只有将 services.read.mode设定为0才会开启该功能。 |
| services.write.mode | 整数 | 对业务开启读写访问。 可配置的参数包括： 0 - （缺省值） 设定业务的读写访问，通过 services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。1 - 对所有业务开启读写访问。 |
| services.write.list | 数组 | 包含一组业务对象。 列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| services.write.tag | 对象 | 包含一组业务标签对象。 标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| modules | 数组 | 包含一组模块对象。 |
| modules.default_access | 整数 | 表示对新模块开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.access | 证书 | 表示对API开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.mode | 整数 | 对罗列在api属性中的API的方式进行模式设定。可配置的参数包括： 0 - （缺省值） 拒绝列表； 1 - 允许列表。 |
| api | 数组 | 包含一组API的方式。 |
| actions | 数组 | 包含一组动作对象。 |
| actions.default_access | 整数 | 表示对新的动作是否开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| services.read.tag | 对象 | 包含一组业务标签对象的参数。 标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。 只有将 services.read.mode设定为0才会开启该功能。 |
| services.write.mode | 整数 | 对业务开启读写访问。 可配置的参数包括： 0 - （缺省值） 设定业务的读写访问，通过 services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。1 - 对所有业务开启读写访问。 |
| services.write.list | 数组 | 包含一组业务对象。 列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| services.write.tag | 对象 | 包含一组业务标签对象。 标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| modules | 数组 | 包含一组模块对象。 |
| modules.default_access | 整数 | 表示对新模块开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.access | 证书 | 表示对API开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.mode | 整数 | 对罗列在api属性中的API的方式进行模式设定。可配置的参数包括： 0 - （缺省值） 拒绝列表； 1 - 允许列表。 |
| api | 数组 | 包含一组API的方式。 |
| actions | 数组 | 包含一组动作对象。 |
| actions.default_access | 整数 | 表示对新的动作是否开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| services.read.tag | 对象 | 包含一组业务标签对象的参数。 标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。 只有将 services.read.mode设定为0才会开启该功能。 |
| services.write.mode | 整数 | 对业务开启读写访问。 可配置的参数包括： 0 - （缺省值） 设定业务的读写访问，通过 services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。1 - 对所有业务开启读写访问。 |
| services.write.list | 数组 | 包含一组业务对象。 列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| services.write.tag | 对象 | 包含一组业务标签对象。 标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| modules | 数组 | 包含一组模块对象。 |
| modules.default_access | 整数 | 表示对新模块开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.access | 证书 | 表示对API开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.mode | 整数 | 对罗列在api属性中的API的方式进行模式设定。可配置的参数包括： 0 - （缺省值） 拒绝列表； 1 - 允许列表。 |
| api | 数组 | 包含一组API的方式。 |
| actions | 数组 | 包含一组动作对象。 |
| actions.default_access | 整数 | 表示对新的动作是否开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| services.read.tag | 对象 | 包含一组业务标签对象的参数。 标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。 只有将 services.read.mode设定为0才会开启该功能。 |
| services.write.mode | 整数 | 对业务开启读写访问。 可配置的参数包括： 0 - （缺省值） 设定业务的读写访问，通过 services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。1 - 对所有业务开启读写访问。 |
| services.write.list | 数组 | 包含一组业务对象。 列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| services.write.tag | 对象 | 包含一组业务标签对象。 标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。 只有将 services.write.mode设定为0才会开启该功能。 |
| modules | 数组 | 包含一组模块对象。 |
| modules.default_access | 整数 | 表示对新模块开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.access | 证书 | 表示对API开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
| api.mode | 整数 | 对罗列在api属性中的API的方式进行模式设定。可配置的参数包括： 0 - （缺省值） 拒绝列表； 1 - 允许列表。 |
| api | 数组 | 包含一组API的方式。 |
| actions | 数组 | 包含一组动作对象。 |
| actions.default_access | 整数 | 表示对新的动作是否开启访问。 可配置的参数包括： 0 - 关闭； 1 - （缺省值） 开启。 |
UI元素
UI元素对象具有以下属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| name | string | UI元素的名称。 如果Role对象的 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 - 报表 → 触发器前100。如果Role对象的 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 - *告警 → |
服务
服务标签
| 属性 | 类型 | 描述 |
|---|---|---|
| tag | string | 标签名称。 如果指定为空字符串，服务标签将不会用于服务匹配。 属性行为: - 必填 |
| value | string | 标签值。 如果没有指定值或为空字符串，仅使用标签名称进行服务匹配。 |
模块
模块对象具有以下属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| moduleid | ID | 模块的ID。 属性行为: - 必填 |
| status | 整数 | 模块访问是否启用。 可能的值： 0 - 禁用; 1 - (默认) 启用。 |
动作
动作对象具有以下属性：
| 属性 | 类型 | 描述 |
|---|---|---|
| name | 字符串 | 动作的名称。 如果角色对象的 type设置为"用户"，"管理员"，或"超级管理员"，可能的值为：edit_dashboards - 创建和编辑仪表盘；edit_maps - 创建和编辑拓扑图；add_problem_comments - 添加问题评论；change_severity - 更改问题严重性；acknowledge_problems - 确认问题；suppress_problems - 抑制问题；close_problems - 关闭问题；execute_scripts - 执行脚本；manage_api_tokens - 管理API令牌。如果角色对象的 type设置为"管理员"或"超级管理员"，可能的值为：edit_maintenance - 创建和编辑维护；manage_scheduled_reports - 管理计划报表；manage_sla - 管理SLA。如果角色对象的 type设置为"用户"或"管理员"，可能的值为：invoke_execute_now - 允许仅具有主机读权限的用户执行监控项检查。属性行为： - 必需 |
| status | 整数 | 是否启用执行动作的访问权限。 可能的值： 0 - 禁用； 1 - (默认) 启用。 |