通过 REST 表 API.
功能概述
通过 REST 表 API.是一项面向实际任务的技能,主要用于Setup. 设置环境变量用于您的 ServiceNow 实例: 下面所有工具都使用脚本/ sn.sh。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
核心要点
- 使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。
- 该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。
- 从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
使用与执行
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。
结果检查与注意事项
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
ServiceNow 技能
通过 REST Table API 查询和管理任意 ServiceNow 实例中的记录。
配置
为您的 ServiceNow 实例设置环境变量:
export SN_INSTANCE="https://yourinstance.service-now.com"
export SN_USER="your_username"
export SN_PASSWORD="your_password"
以下所有工具均调用 scripts/sn.sh,该脚本会读取上述环境变量。
工具
sn_query — 查询任意表
bash scripts/sn.sh query
[options]
选项:
--query "" — ServiceNow 编码查询(例如:active=true^priority=1)
--fields "" — 以逗号分隔的待返回字段列表
--limit — 最大返回记录数(默认为 20)
--offset — 分页偏移量
--orderby "" — 排序字段(前缀加 - 表示降序)
--display — 显示值模式
示例:
# 列出当前打开的 P1 级别事件
bash scripts/sn.sh query incident --query "active=true^priority=1" --fields "number,short_description,state,assigned_to" --limit 10
# IT 部门下的所有用户
bash scripts/sn.sh query sys_user --query "department=IT" --fields "user_name,email,name"
# 最近的变更请求
bash scripts/sn.sh query change_request --query "sys_created_on>=2024-01-01" --orderby "-sys_created_on" --limit 5
sn_get — 根据 sys_id 获取单条记录
bash scripts/sn.sh get
[options]
选项:
--fields "" — 待返回字段
--display — 显示值模式
示例:
bash scripts/sn.sh get incident abc123def456 --fields "number,short_description,state,assigned_to" --display true
sn_create — 创建记录
bash scripts/sn.sh create
''
示例:
bash scripts/sn.sh create incident '{"short_description":"Server down","urgency":"1","impact":"1","assignment_group":"Service Desk"}'
sn_update — 更新记录
bash scripts/sn.sh update
''
示例:
bash scripts/sn.sh update incident abc123def456 '{"state":"6","close_code":"Solved (Permanently)","close_notes":"Restarted service"}'
sn_delete — 删除记录
bash scripts/sn.sh delete
--confirm
--confirm 参数为必需项,用于防止误删。
sn_aggregate — 聚合查询
bash scripts/sn.sh aggregate
--type [options]
支持类型:COUNT、AVG、MIN、MAX、SUM
选项:
--type — 聚合类型(必需)
--query "" — 过滤记录
--field "" — 执行聚合操作的目标字段(AVG/MIN/MAX/SUM 类型必需)
--group-by "" — 按指定字段对结果进行分组
--display — 显示值模式
示例:
# 按优先级统计当前打开的事件数量
bash scripts/sn.sh aggregate incident --type COUNT --query "active=true" --group-by "priority"
# 计算当前打开事件的平均重新指派次数
bash scripts/sn.sh aggregate incident --type AVG --field "reassignment_count" --query "active=true"
sn_schema — 获取表结构
bash scripts/sn.sh schema
[--fields-only]
返回字段名、字段类型、最大长度、是否必填、引用目标及选择列表(choice)值。
使用 --fields-only 可仅输出精简字段列表。
sn_batch — 批量更新或删除记录
bash scripts/sn.sh batch
--query "" --action [--fields '{"field":"value"}' --limit 200] [--confirm]
对匹配查询条件的所有记录执行批量更新或删除操作。默认运行于模拟模式(dry-run) —— 仅显示匹配记录数,不实际执行变更。添加 --confirm 参数后才真正执行操作。
选项:
--query "" — 指定需操作的记录筛选条件(必需)
--action — 操作类型(必需)
--fields '' — 更新时需设置的 JSON 字段(仅 update 操作必需)
--limit — 单次操作影响的最大记录数(默认为 200,安全上限为 10000)
--dry-run — 仅显示匹配数量,不执行任何变更(默认行为)
--confirm — 实际执行操作(禁用 dry-run)
示例:
# 模拟运行:查看有多少条已解决且超过 90 天未更新的事件将被影响
bash scripts/sn.sh batch incident --query "state=6^sys_updated_on
输出(JSON 摘要):
{"action":"update","table":"incident","matched":47,"processed":47,"failed":0}
sn_health — 实例健康检查
bash scripts/sn.sh health [--check ]
对 ServiceNow 实例进行多维度健康检查。默认执行 --check all,即运行全部检查项。
检查项:
- version — 从 sys_properties 中获取实例构建版本、日期与标签
- nodes — 从 sys_cluster_state 中获取集群节点状态(online/offline)
- jobs — 从 sys_trigger 中查找卡住/超期的定时任务(state=ready 且 next_action 已超时 30 分钟以上)
- semaphores — 从 sys_semaphore 中获取活跃信号量(可能存在锁竞争)
- stats — 快速仪表盘:活跃事件数、开放的 P1 级事件数、活跃变更请求数、开放问题数
示例:
# 完整健康检查
bash scripts/sn.sh health
# 仅检查版本信息
bash scripts/sn.sh health --check version
# 检查是否存在卡住的任务
bash scripts/sn.sh health --check jobs
# 快速查看事件/变更/问题仪表盘
bash scripts/sn.sh health --check stats
输出(JSON):
{
"instance": "https://yourinstance.service-now.com",
"timestamp": "2026-02-16T13:30:00Z",
"version": {"build": "...", "build_date": "...", "build_tag": "..."},
"nodes": [{"node_id": "...", "status": "online", "system_id": "..."}],
"jobs": {"stuck": 0, "overdue": []},
"semaphores": {"active": 2, "list": []},
"stats": {"incidents_active": 54, "p1_open": 3, "changes_active": 12, "problems_open": 8}
}
sn_attach — 管理附件
# 列出某条记录上的附件
bash scripts/sn.sh attach list
# 下载附件
bash scripts/sn.sh attach download
# 上传附件
bash scripts/sn.sh attach upload [content_type]
常用表名
| 表名 |
说明 |
incident |
事件 |
change_request |
变更请求 |
problem |
问题 |
sc_req_item |
已申请项目(RITMs) |
sc_request |
请求 |
sys_user |
用户 |
sys_user_group |
用户组 |
cmdb_ci |
配置项(CI) |
cmdb_ci_server |
服务器 |
kb_knowledge |
知识文章 |
task |
任务(incident/change/problem 的父表) |
sys_choice |
选择列表(choice list)值 |
编码查询语法
ServiceNow 编码查询中,^ 表示 AND,^OR 表示 OR:
active=true^priority=1 — 活跃状态 AND P1 级别
active=true^ORactive=false — 活跃状态 OR 非活跃状态
short_descriptionLIKEserver — 描述中包含 “server”
sys_created_on>=2024-01-01 — 创建时间在指定日期之后
assigned_toISEMPTY — 未分配
stateIN1,2,3 — state 字段值为 1、2 或 3
caller_id.name=John Smith — 使用点号遍历引用字段(dot-walk)
注意事项
- 所有 API 调用均通过
SN_USER / SN_PASSWORD 使用 Basic Auth 认证
- 默认返回最多 20 条记录;可通过
--limit 参数调整
- 使用
--display true 可使引用字段返回人类可读值(而非 sys_id)
- 脚本会自动识别
SN_INSTANCE 是否已包含协议前缀(如 https://)
GoFrame框架Web开发与路由中间件
本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。
GoFrame框架安装与gf命令行工具
本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。
GoFrame框架零基础入门
本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。
SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。
SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。
SQLAlchemy ORM 模型怎么写
SQLAlchemy ORM 模型怎么写?本专题整理模型类定义、Mapped 字段映射、主键与约束、表结构创建和常见报错的相关文章,帮助你从基础配置到实际建模逐步掌握 SQLAlchemy。
Go-Zero API开发使用教程
本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。
Go-Zero安装与goctl环境配置教程
本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。
Go-Zero零基础入门教程
本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。
网站特效
/
网站源码
/
网站素材
/
前端模板