pagerduty-api

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

PagerDuty API

This document describes the PagerDuty REST APIs.

本文档介绍PagerDuty REST API。

How to Use This Skill

如何使用本技能

This API documentation is split into multiple files for on-demand loading.

Directory structure:

references/
├── resources/      # 40 resource index files
├── operations/     # 390 operation detail files
└── schemas/        # 89 schema groups, 244 schema files

Navigation flow:

Find the resource you need in the list below
Read
```
references/resources/<resource>.md
```
to see available operations
Read
```
references/operations/<operation>.md
```
for full details
If an operation references a schema, read
```
references/schemas/<prefix>/<schema>.md
```

本API文档被拆分为多个文件，支持按需加载。

目录结构：

references/
├── resources/      # 40个资源索引文件
├── operations/     # 390个操作详情文件
└── schemas/        # 89个模式组，244个模式文件

导航流程：

在下方列表中找到你需要的资源
阅读
```
references/resources/<resource>.md
```
查看可用操作
阅读
```
references/operations/<operation>.md
```
获取完整详情
如果某个操作引用了模式，请阅读
```
references/schemas/<prefix>/<schema>.md
```

Base URL

基础URL

```
https://api.pagerduty.com
```
- PagerDuty V2 API.

```
https://api.pagerduty.com
```
- PagerDuty V2 API。

Authentication

认证

Supported methods: api_key. See

references/authentication.md

for details.

支持的方式：api_key。详情请见

references/authentication.md

。

Resources

资源

Event Orchestrations →
```
references/resources/Event-Orchestrations.md
```
(39 ops) - Event Orchestrations allow you to route events to
Users →
```
references/resources/Users.md
```
(35 ops) - Users are members of a PagerDuty account that have
Incidents →
```
references/resources/Incidents.md
```
(28 ops) - An incident represents a problem or an issue that
Status Pages →
```
references/resources/Status-Pages.md
```
(27 ops) - Status Pages can be public or private read-only pa
Automation Actions →
```
references/resources/Automation-Actions.md
```
(25 ops) - Automation Actions invoke jobs that are staged in
Services →
```
references/resources/Services.md
```
(19 ops) - A Service may represent an application, component,
Analytics →
```
references/resources/Analytics.md
```
(16 ops) - Provides enriched incident data.
Business Services →
```
references/resources/Business-Services.md
```
(16 ops) - Business services model capabilities that span mul
Incident Workflows →
```
references/resources/Incident-Workflows.md
```
(15 ops) - An Incident Workflow is a sequence of configurable
Incident Types →
```
references/resources/Incident-Types.md
```
(14 ops) - Incident Types are a feature which will allow cust
Teams →
```
references/resources/Teams.md
```
(14 ops) - A team is a collection of Users and Escalation Pol
Webhooks →
```
references/resources/Webhooks.md
```
(12 ops) - A webhook is a way to receive events that occur on
Schedules →
```
references/resources/Schedules.md
```
(11 ops) - A Schedule determines the time periods that users
Rulesets →
```
references/resources/Rulesets.md
```
(10 ops) - Rulesets allow you to route events to an endpoint
Service Custom Fields →
```
references/resources/Service-Custom-Fields.md
```
(10 ops) - Custom fields allow you to enrich PagerDuty servic
Incident Custom Fields →
```
references/resources/Incident-Custom-Fields.md
```
(9 ops) - Custom fields allow you to enrich PagerDuty incide
Workflow Integrations →
```
references/resources/Workflow-Integrations.md
```
(8 ops) - Workflow Integrations are a way to connect PagerDu
Tags →
```
references/resources/Tags.md
```
(7 ops) - A Tag is applied to Escalation Policies, Teams or
Templates →
```
references/resources/Templates.md
```
(7 ops) - Templates is a new feature which will allow custom
Change Events →
```
references/resources/Change-Events.md
```
(6 ops) - Change Events enable you to send informational eve
Escalation Policies →
```
references/resources/Escalation-Policies.md
```
(6 ops) - Escalation policies define which user should be al
Extensions →
```
references/resources/Extensions.md
```
(6 ops) - Extensions are representations of Extension Schema
Add-ons →
```
references/resources/Add-ons.md
```
(5 ops) - Developers can write their own functionality to in
Alert Grouping Settings →
```
references/resources/Alert-Grouping-Settings.md
```
(5 ops) - Alert Grouping Settings allow you to configure how
Maintenance Windows →
```
references/resources/Maintenance-Windows.md
```
(5 ops) - A Maintenance Window is used to temporarily disabl
Status Dashboards →
```
references/resources/Status-Dashboards.md
```
(5 ops) - Status Dashboards represent user-defined views for
Service Dependencies →
```
references/resources/Service-Dependencies.md
```
(4 ops) - Services are categorized into technical and busine
Standards →
```
references/resources/Standards.md
```
(4 ops) - Standards help provide a clear understanding of wh
Log Entries →
```
references/resources/Log-Entries.md
```
(3 ops) - A log of all the events that happen to an Incident

Session Configurations →

references/resources/Session-Configurations.md

(3 ops)

Abilities →
```
references/resources/Abilities.md
```
(2 ops) - This describes your account's abilities by feature
Extension Schemas →
```
references/resources/Extension-Schemas.md
```
(2 ops) - A PagerDuty extension vendor represents a specific
Licenses →
```
references/resources/Licenses.md
```
(2 ops) - Licenses are allocated to Users to allow for per-U

OAuth Delegations →

references/resources/OAuth-Delegations.md

(2 ops)

Paused Incident Reports →
```
references/resources/Paused-Incident-Reports.md
```
(2 ops) - Provides paused Incident reporting data on service
Vendors →
```
references/resources/Vendors.md
```
(2 ops) - A PagerDuty Vendor represents a specific type of i
Audit →
```
references/resources/Audit.md
```
(1 ops) - Provides audit record data.
Notifications →
```
references/resources/Notifications.md
```
(1 ops) - A Notification is created when an Incident is trig
On-Calls →
```
references/resources/On-Calls.md
```
(1 ops) - An on-call represents a contiguous unit of time fo
Priorities →
```
references/resources/Priorities.md
```
(1 ops) - A priority is a label representing the importance

Event Orchestrations →
```
references/resources/Event-Orchestrations.md
```
（39个操作）- 事件编排允许你将事件路由至
Users →
```
references/resources/Users.md
```
（35个操作）- 用户是PagerDuty账户的成员，拥有
Incidents →
```
references/resources/Incidents.md
```
（28个操作）- 事件代表一个问题或故障，
Status Pages →
```
references/resources/Status-Pages.md
```
（27个操作）- 状态页面可以是公开或私有只读页面
Automation Actions →
```
references/resources/Automation-Actions.md
```
（25个操作）- 自动化操作可触发已部署的作业
Services →
```
references/resources/Services.md
```
（19个操作）- 服务可以代表一个应用、组件，
Analytics →
```
references/resources/Analytics.md
```
（16个操作）- 提供丰富的事件数据。
Business Services →
```
references/resources/Business-Services.md
```
（16个操作）- 业务服务对跨多个系统的能力进行建模
Incident Workflows →
```
references/resources/Incident-Workflows.md
```
（15个操作）- 事件工作流是一系列可配置的
Incident Types →
```
references/resources/Incident-Types.md
```
（14个操作）- 事件类型是一项允许客户
Teams →
```
references/resources/Teams.md
```
（14个操作）- 团队是用户和升级策略的集合
Webhooks →
```
references/resources/Webhooks.md
```
（12个操作）- Webhook是一种接收平台上发生事件的方式
Schedules →
```
references/resources/Schedules.md
```
（11个操作）- 排班表用于确定用户的值班时间段
Rulesets →
```
references/resources/Rulesets.md
```
（10个操作）- 规则集允许你将事件路由至指定端点
Service Custom Fields →
```
references/resources/Service-Custom-Fields.md
```
（10个操作）- 自定义字段允许你丰富PagerDuty服务的信息
Incident Custom Fields →
```
references/resources/Incident-Custom-Fields.md
```
（9个操作）- 自定义字段允许你丰富PagerDuty事件的信息
Workflow Integrations →
```
references/resources/Workflow-Integrations.md
```
（8个操作）- 工作流集成是连接PagerDuty与其他系统的方式
Tags →
```
references/resources/Tags.md
```
（7个操作）- 标签可应用于升级策略、团队或
Templates →
```
references/resources/Templates.md
```
（7个操作）- 模板是一项新功能，允许用户自定义
Change Events →
```
references/resources/Change-Events.md
```
（6个操作）- 变更事件允许你发送信息性事件
Escalation Policies →
```
references/resources/Escalation-Policies.md
```
（6个操作）- 升级策略定义了应该通知哪些用户
Extensions →
```
references/resources/Extensions.md
```
（6个操作）- 扩展是扩展模式的具体实现
Add-ons →
```
references/resources/Add-ons.md
```
（5个操作）- 开发者可以编写自定义功能以集成到
Alert Grouping Settings →
```
references/resources/Alert-Grouping-Settings.md
```
（5个操作）- 告警分组设置允许你配置如何
Maintenance Windows →
```
references/resources/Maintenance-Windows.md
```
（5个操作）- 维护窗口用于临时禁用
Status Dashboards →
```
references/resources/Status-Dashboards.md
```
（5个操作）- 状态仪表板代表用户自定义的视图
Service Dependencies →
```
references/resources/Service-Dependencies.md
```
（4个操作）- 服务分为技术服务和业务服务
Standards →
```
references/resources/Standards.md
```
（4个操作）- 标准有助于清晰界定
Log Entries →
```
references/resources/Log-Entries.md
```
（3个操作）- 记录事件发生的所有操作日志

Session Configurations →

references/resources/Session-Configurations.md

（3个操作）

Abilities →
```
references/resources/Abilities.md
```
（2个操作）- 描述你的账户按功能划分的权限
Extension Schemas →
```
references/resources/Extension-Schemas.md
```
（2个操作）- PagerDuty扩展供应商代表特定类型的
Licenses →
```
references/resources/Licenses.md
```
（2个操作）- 许可证分配给用户以允许按用户

OAuth Delegations →

references/resources/OAuth-Delegations.md

（2个操作）

Paused Incident Reports →
```
references/resources/Paused-Incident-Reports.md
```
（2个操作）- 提供服务的暂停事件报告数据
Vendors →
```
references/resources/Vendors.md
```
（2个操作）- PagerDuty供应商代表特定类型的集成
Audit →
```
references/resources/Audit.md
```
（1个操作）- 提供审计记录数据。
Notifications →
```
references/resources/Notifications.md
```
（1个操作）- 当事件被触发时会创建通知
On-Calls →
```
references/resources/On-Calls.md
```
（1个操作）- 值班代表一段连续的时间
Priorities →
```
references/resources/Priorities.md
```
（1个操作）- 优先级是代表事件重要性的标签