@leaflow/sdk 0.14.2 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,8 +11,8 @@ export interface paths {
11
11
  cookie?: never;
12
12
  };
13
13
  /**
14
- * 列出告警
15
- * @description `incident_status` 表示监控系统是否判定已恢复,`closed` 表示是否有人完成了处理。两者相互独立,可分别筛选。
14
+ * List incidents
15
+ * @description `incident_status` reports whether monitoring considers the problem recovered; `closed` reports whether someone has finished handling it. The two are independent and can be filtered separately.
16
16
  */
17
17
  get: operations["list-incidents"];
18
18
  put?: never;
@@ -30,7 +30,7 @@ export interface paths {
30
30
  path?: never;
31
31
  cookie?: never;
32
32
  };
33
- /** 查一条告警 */
33
+ /** Get an incident */
34
34
  get: operations["get-incident"];
35
35
  put?: never;
36
36
  post?: never;
@@ -50,8 +50,8 @@ export interface paths {
50
50
  get?: never;
51
51
  put?: never;
52
52
  /**
53
- * 确认这条告警
54
- * @description 同时会在监控系统中标记为已确认,便于其他渠道也能看到该告警已有人处理。
53
+ * Acknowledge an incident
54
+ * @description The incident is also marked as acknowledged in the monitoring system, so that other channels can see it already has an owner.
55
55
  */
56
56
  post: operations["acknowledge-incident"];
57
57
  delete?: never;
@@ -69,10 +69,10 @@ export interface paths {
69
69
  };
70
70
  get?: never;
71
71
  /**
72
- * 把这条告警交给谁,或者收回来
73
- * @description `assignee_user_id` 留空即取消指派。
72
+ * Assign an incident, or clear its assignee
73
+ * @description Leave `assignee_user_id` empty to clear the assignment.
74
74
  *
75
- * **这里不校验被指派的人在不在这个项目里**——那要问 IAM,而这个服务的准入还没接。
75
+ * **Project membership of the assignee is not verified.** Any user identifier is accepted and recorded as given.
76
76
  */
77
77
  put: operations["assign-incident"];
78
78
  post?: never;
@@ -92,8 +92,8 @@ export interface paths {
92
92
  get?: never;
93
93
  put?: never;
94
94
  /**
95
- * 了结这条告警
96
- * @description 了结的是**平台上的处理流程**,不是告警本身的状态:尚未恢复的告警也可以按「已接受的风险」了结,它在监控系统中仍为未恢复。
95
+ * Close an incident
96
+ * @description Closing records **that the handling process is finished on this platform**; it does not change the state of the incident itself. An incident that has not recovered may still be closed as an accepted risk, and remains unrecovered in the monitoring system.
97
97
  */
98
98
  post: operations["close-incident"];
99
99
  delete?: never;
@@ -111,7 +111,7 @@ export interface paths {
111
111
  };
112
112
  get?: never;
113
113
  put?: never;
114
- /** 在时间线上写一条备注 */
114
+ /** Add a note to the timeline */
115
115
  post: operations["add-incident-comment"];
116
116
  delete?: never;
117
117
  options?: never;
@@ -128,8 +128,8 @@ export interface paths {
128
128
  };
129
129
  get?: never;
130
130
  /**
131
- * 关注这条告警,或者取消关注
132
- * @description 关注的是**自己**:操作者就是被加进关注列表的那个人。
131
+ * Follow an incident, or stop following it
132
+ * @description You follow **yourself**: the caller is the user added to or removed from the follower list.
133
133
  */
134
134
  put: operations["set-incident-following"];
135
135
  post?: never;
@@ -148,7 +148,7 @@ export interface paths {
148
148
  };
149
149
  get?: never;
150
150
  put?: never;
151
- /** 重新打开一条已经了结的告警 */
151
+ /** Reopen a closed incident */
152
152
  post: operations["reopen-incident"];
153
153
  delete?: never;
154
154
  options?: never;
@@ -164,8 +164,8 @@ export interface paths {
164
164
  cookie?: never;
165
165
  };
166
166
  /**
167
- * 列出这条告警的时间线
168
- * @description 游标翻页而不是偏移量:时间线是只增的,用偏移量翻页会在新记录写入时漏行和重行。
167
+ * List the timeline of an incident
168
+ * @description Cursor paging rather than offset paging: the timeline is append-only, and offset paging would skip or repeat entries whenever a new one is written.
169
169
  */
170
170
  get: operations["list-incident-timeline"];
171
171
  put?: never;
@@ -183,7 +183,7 @@ export interface paths {
183
183
  path?: never;
184
184
  cookie?: never;
185
185
  };
186
- /** 列出维护窗口 */
186
+ /** List maintenance windows */
187
187
  get: operations["list-maintenance-windows"];
188
188
  put?: never;
189
189
  post?: never;
@@ -200,19 +200,19 @@ export interface paths {
200
200
  path?: never;
201
201
  cookie?: never;
202
202
  };
203
- /** 查一个维护窗口 */
203
+ /** Get a maintenance window */
204
204
  get: operations["get-maintenance-window"];
205
205
  /**
206
- * 开一个维护窗口,或者按同一个 id 覆盖它
207
- * @description **创建即覆盖**:延长一个正在进行的窗口就是用同一个 id 再调一次。
206
+ * Create a maintenance window, or replace it by the same id
207
+ * @description **Create or replace**: extending a window that is already running means calling this endpoint again with the same id.
208
208
  *
209
- * 窗口期内这些机器的问题不告警,也不扣 SLA 的可用率。`server_ids` 留空表示整个项目,包括窗口开着的时候新接进来的机器。
209
+ * While the window is open, problems on these machines do not alert and do not count against SLA availability. Leave `server_ids` empty to cover the entire project, including machines enrolled after the window opens.
210
210
  */
211
211
  put: operations["put-maintenance-window"];
212
212
  post?: never;
213
213
  /**
214
- * 撤掉一个维护窗口
215
- * @description 立刻恢复告警,哪怕窗口还没到期。
214
+ * Cancel a maintenance window
215
+ * @description Alerting resumes immediately, even if the window has not yet expired.
216
216
  */
217
217
  delete: operations["delete-maintenance-window"];
218
218
  options?: never;
@@ -228,8 +228,8 @@ export interface paths {
228
228
  cookie?: never;
229
229
  };
230
230
  /**
231
- * 项目总览
232
- * @description 项目下还没有任何机器时返回各项均为零的总览,而不是 404——空项目是一个正常状态。
231
+ * Project overview
232
+ * @description A project with no machines yet returns an overview with every figure at zero rather than a 404 — an empty project is a normal state.
233
233
  */
234
234
  get: operations["get-project-overview"];
235
235
  put?: never;
@@ -248,8 +248,8 @@ export interface paths {
248
248
  cookie?: never;
249
249
  };
250
250
  /**
251
- * 列出一台机器的监控项
252
- * @description 原样返回采集到的监控项,不做筛选或重命名。哪些属于重要指标,由调用方依据监控项自带的标签自行判断。
251
+ * List the monitoring items of a machine
252
+ * @description Items are returned exactly as collected, without filtering or renaming. Which of them count as important is for the caller to decide from the tags carried by each item.
253
253
  */
254
254
  get: operations["list-server-items"];
255
255
  put?: never;
@@ -268,8 +268,8 @@ export interface paths {
268
268
  cookie?: never;
269
269
  };
270
270
  /**
271
- * 取一个监控项的时间序列
272
- * @description `item_key` 是**前缀匹配**:按分区、按网卡发现出来的监控项 key 带参数(`vfs.fs.size[/var,pused]`),所以 `vfs.fs.size` 这一个请求就能画出每个挂载点一条线。
271
+ * Get the time series of a monitoring item
272
+ * @description `item_key` is matched **by prefix**. Keys discovered per partition or per interface carry parameters (`vfs.fs.size[/var,pused]`), so a single request for `vfs.fs.size` returns one series per mount point.
273
273
  */
274
274
  get: operations["get-server-metric"];
275
275
  put?: never;
@@ -287,7 +287,7 @@ export interface paths {
287
287
  path?: never;
288
288
  cookie?: never;
289
289
  };
290
- /** 一台机器的硬件与接口 */
290
+ /** Hardware and interfaces of a machine */
291
291
  get: operations["get-server-resources"];
292
292
  put?: never;
293
293
  post?: never;
@@ -304,7 +304,7 @@ export interface paths {
304
304
  path?: never;
305
305
  cookie?: never;
306
306
  };
307
- /** 一台机器此刻的状态 */
307
+ /** Current state of a machine */
308
308
  get: operations["get-server-snapshot"];
309
309
  put?: never;
310
310
  post?: never;
@@ -321,7 +321,7 @@ export interface paths {
321
321
  path?: never;
322
322
  cookie?: never;
323
323
  };
324
- /** 某个指标最高的前几台 */
324
+ /** Machines ranked highest by a given metric */
325
325
  get: operations["list-project-top-items"];
326
326
  put?: never;
327
327
  post?: never;
@@ -338,7 +338,7 @@ export interface paths {
338
338
  path?: never;
339
339
  cookie?: never;
340
340
  };
341
- /** 列出项目里的机器 */
341
+ /** List the machines in the project */
342
342
  get: operations["list-servers"];
343
343
  put?: never;
344
344
  post?: never;
@@ -355,28 +355,28 @@ export interface paths {
355
355
  path?: never;
356
356
  cookie?: never;
357
357
  };
358
- /** 查一台机器的接入情况 */
358
+ /** Get the enrollment state of a machine */
359
359
  get: operations["get-server"];
360
360
  /**
361
- * 把一台机器接入监控
362
- * @description **同一个 server id 重复调用是幂等的**:参数一致时返回已接入的那台,不会重复创建监控主机,因此接入失败可以安全重试。
361
+ * Enroll a machine into monitoring
362
+ * @description **Repeated calls with the same server id are idempotent**: given identical parameters, the already-enrolled machine is returned and no duplicate host is created, so a failed enrollment is safe to retry.
363
363
  *
364
- * 修改接入参数请改用 PATCH。本接口在参数不一致时会返回错误,不会更新已有配置。
364
+ * To change enrollment settings, use PATCH. This endpoint returns an error when the parameters differ, and does not update an existing configuration.
365
365
  *
366
- * 响应中的 `tls_psk` **只返回这一次**,请及时保存;遗失后需要轮换。
366
+ * The `tls_psk` in the response is **returned only this once**; store it immediately. If it is lost, it must be rotated.
367
367
  */
368
368
  put: operations["enable-server-monitoring"];
369
369
  post?: never;
370
370
  /**
371
- * 删掉这台机器
372
- * @description **不可逆**:监控主机、历史数据和这台机器名下的告警会一并删除。若只是想暂时停止采集,改用 /disable
371
+ * Delete a machine
372
+ * @description **Irreversible**: the monitored host, its history and every incident recorded against this machine are removed together. To stop collection temporarily, use `/disable` instead.
373
373
  */
374
374
  delete: operations["delete-server"];
375
375
  options?: never;
376
376
  head?: never;
377
377
  /**
378
- * 改一台机器的接入参数
379
- * @description 只更新请求体中出现的字段。`address` `address_kind` 必须一并提供:只改其中一个会得到互相矛盾的接入配置,该错误不会被报出,表现为 agent 连不上。
378
+ * Update the enrollment settings of a machine
379
+ * @description Only the fields present in the request body are updated. `address` and `address_kind` must be supplied together: changing one without the other produces a contradictory configuration that is not reported as an error and shows up only as an agent that cannot connect.
380
380
  */
381
381
  patch: operations["update-server"];
382
382
  trace?: never;
@@ -391,8 +391,8 @@ export interface paths {
391
391
  get?: never;
392
392
  put?: never;
393
393
  /**
394
- * 停止监控这台机器
395
- * @description 可逆操作:监控主机保留,仅停止采集,历史数据不受影响。重新接入即可恢复采集。如需连同历史数据一并删除,改用 DELETE
394
+ * Stop monitoring a machine
395
+ * @description Reversible: the monitored host is retained, only collection stops, and history is unaffected. Enrolling again resumes collection. To remove the history as well, use DELETE.
396
396
  */
397
397
  post: operations["disable-server-monitoring"];
398
398
  delete?: never;
@@ -411,8 +411,8 @@ export interface paths {
411
411
  get?: never;
412
412
  put?: never;
413
413
  /**
414
- * 换一把 agent PSK
415
- * @description 换完要同步改 agent 侧的配置,否则那台机器立刻失联。新密钥同样**只在这个响应里明文出现一次**。
414
+ * Rotate the agent PSK
415
+ * @description The agent configuration must be updated to match, otherwise the machine loses contact immediately. The new key is likewise **returned in clear text only in this response**.
416
416
  */
417
417
  post: operations["rotate-agent-psk"];
418
418
  delete?: never;
@@ -428,17 +428,17 @@ export interface paths {
428
428
  path?: never;
429
429
  cookie?: never;
430
430
  };
431
- /** 查一个网页检查 */
431
+ /** Get a web check */
432
432
  get: operations["get-web-check"];
433
433
  /**
434
- * 建一个网页检查,或者按同一个 id 覆盖它
435
- * @description **创建即覆盖**:修改一个检查即用同一个 id 再次调用本接口,无需先判断它是否已存在。
434
+ * Create a web check, or replace it by the same id
435
+ * @description **Create or replace**: to modify a check, call this endpoint again with the same id. There is no need to determine first whether it already exists.
436
436
  */
437
437
  put: operations["put-web-check"];
438
438
  post?: never;
439
439
  /**
440
- * 删掉一个网页检查
441
- * @description 同时删除监控系统中对应的检查任务和触发器,不会遗留永远无法恢复的告警。
440
+ * Delete a web check
441
+ * @description The corresponding check task and trigger are removed from the monitoring system as well, so no permanently unrecoverable alert is left behind.
442
442
  */
443
443
  delete: operations["delete-web-check"];
444
444
  options?: never;
@@ -453,7 +453,7 @@ export interface paths {
453
453
  path?: never;
454
454
  cookie?: never;
455
455
  };
456
- /** 列出网页检查 */
456
+ /** List web checks */
457
457
  get: operations["list-web-checks"];
458
458
  put?: never;
459
459
  post?: never;
@@ -471,10 +471,10 @@ export interface paths {
471
471
  cookie?: never;
472
472
  };
473
473
  /**
474
- * 查实测的达成情况
475
- * @description SLI 是测出来的数,SLO 是定下来的目标——这里返回的是前者。
474
+ * Get measured availability
475
+ * @description SLI is what was measured; SLO is what was promised — this endpoint returns the former.
476
476
  *
477
- * `server_id` 为空的那一行是项目整体。
477
+ * The row with an empty `server_id` covers the project as a whole.
478
478
  */
479
479
  get: operations["get-sli-report"];
480
480
  put?: never;
@@ -493,21 +493,21 @@ export interface paths {
493
493
  cookie?: never;
494
494
  };
495
495
  /**
496
- * 查这个项目的可用率目标
497
- * @description 没定过就是 404,而不是一份默认目标:没承诺过和承诺了 99.9% 是两回事。
496
+ * Get the availability target of this project
497
+ * @description A project that has never set one returns 404 rather than a default target: making no promise and promising 99.9% are different things.
498
498
  */
499
499
  get: operations["get-slo"];
500
500
  /**
501
- * 定下这个项目的可用率目标,或者改它
502
- * @description 一个项目一条 SLO,**创建即覆盖**。
501
+ * Set the availability target of this project, or change it
502
+ * @description One SLO per project, **create or replace**.
503
503
  *
504
- * `min_severity` 必须显式选:它决定什么算「不可用」,是这条承诺的一半内容。
504
+ * `min_severity` must be chosen explicitly: it defines what counts as unavailable, which is half of what the target means.
505
505
  */
506
506
  put: operations["put-slo"];
507
507
  post?: never;
508
508
  /**
509
- * 撤掉这个项目的可用率目标
510
- * @description 同时移除监控系统中对应的服务树,此后不再统计可用率。
509
+ * Remove the availability target of this project
510
+ * @description Availability is no longer tracked from this point on.
511
511
  */
512
512
  delete: operations["delete-slo"];
513
513
  options?: never;
@@ -515,6 +515,353 @@ export interface paths {
515
515
  patch?: never;
516
516
  trace?: never;
517
517
  };
518
+ "/api/v1/status-page": {
519
+ parameters: {
520
+ query?: never;
521
+ header?: never;
522
+ path?: never;
523
+ cookie?: never;
524
+ };
525
+ /**
526
+ * Get the status page of this project
527
+ * @description A project has at most one status page. A project that has never created one returns 404.
528
+ */
529
+ get: operations["get-status-page"];
530
+ /**
531
+ * Create the status page, or replace its configuration
532
+ * @description **Create or replace**: changing the title, switching the domain, publishing and unpublishing are all done by sending the complete configuration again.
533
+ *
534
+ * While `published` is false the public address returns 404, including any custom domain already bound. A newly created page is unpublished by default, so that a page still being configured has no address that opens.
535
+ *
536
+ * `slug` and `custom_domain` are **globally unique**; a value already taken returns 409.
537
+ */
538
+ put: operations["put-status-page"];
539
+ post?: never;
540
+ /**
541
+ * Delete the status page
542
+ * @description Its groups, components, availability history, incident notices and scheduled maintenance are removed together, and cannot be recovered. The slug and custom domain are released.
543
+ */
544
+ delete: operations["delete-status-page"];
545
+ options?: never;
546
+ head?: never;
547
+ patch?: never;
548
+ trace?: never;
549
+ };
550
+ "/api/v1/status-page/order": {
551
+ parameters: {
552
+ query?: never;
553
+ header?: never;
554
+ path?: never;
555
+ cookie?: never;
556
+ };
557
+ get?: never;
558
+ /**
559
+ * Set the order of the top level of the page
560
+ * @description Submits the **entire** top-level order in one call rather than moving a single entry to a given position.
561
+ *
562
+ * The top level interleaves groups and ungrouped components, so the order is expressed as one list covering both.
563
+ *
564
+ * Each entry carries either `group_id` or `component_id`. Entries not listed are placed after those that are.
565
+ */
566
+ put: operations["put-status-page-order"];
567
+ post?: never;
568
+ delete?: never;
569
+ options?: never;
570
+ head?: never;
571
+ patch?: never;
572
+ trace?: never;
573
+ };
574
+ "/api/v1/status-page/groups": {
575
+ parameters: {
576
+ query?: never;
577
+ header?: never;
578
+ path?: never;
579
+ cookie?: never;
580
+ };
581
+ /** List groups */
582
+ get: operations["list-status-page-groups"];
583
+ put?: never;
584
+ /**
585
+ * Create a group
586
+ * @description A group is one level of collapsing applied to components on the page. There is exactly one level; groups cannot be nested.
587
+ */
588
+ post: operations["create-status-page-group"];
589
+ delete?: never;
590
+ options?: never;
591
+ head?: never;
592
+ patch?: never;
593
+ trace?: never;
594
+ };
595
+ "/api/v1/status-page/groups/{groupId}": {
596
+ parameters: {
597
+ query?: never;
598
+ header?: never;
599
+ path: {
600
+ groupId: string;
601
+ };
602
+ cookie?: never;
603
+ };
604
+ get?: never;
605
+ /** Update a group */
606
+ put: operations["update-status-page-group"];
607
+ post?: never;
608
+ /**
609
+ * Delete a group
610
+ * @description The components in it are **not deleted**. They return to the top level as ungrouped components, keeping their availability history and the incident notices that reference them.
611
+ */
612
+ delete: operations["delete-status-page-group"];
613
+ options?: never;
614
+ head?: never;
615
+ patch?: never;
616
+ trace?: never;
617
+ };
618
+ "/api/v1/status-page/groups/{groupId}/order": {
619
+ parameters: {
620
+ query?: never;
621
+ header?: never;
622
+ path?: never;
623
+ cookie?: never;
624
+ };
625
+ get?: never;
626
+ /** Set the order of components within a group */
627
+ put: operations["put-status-page-group-order"];
628
+ post?: never;
629
+ delete?: never;
630
+ options?: never;
631
+ head?: never;
632
+ patch?: never;
633
+ trace?: never;
634
+ };
635
+ "/api/v1/status-page/components": {
636
+ parameters: {
637
+ query?: never;
638
+ header?: never;
639
+ path?: never;
640
+ cookie?: never;
641
+ };
642
+ /**
643
+ * List components
644
+ * @description A component is one row on the status page: an externally promised capability. It is not a machine — a single component may be backed by several machines and several web checks.
645
+ */
646
+ get: operations["list-status-page-components"];
647
+ put?: never;
648
+ /**
649
+ * Create a component
650
+ * @description `name` is **customer-facing copy** and appears verbatim on the public page; do not use machine names.
651
+ *
652
+ * `auto_status_min_severity` sets how severe an alert must be before it changes the status of this row; anything below it has no effect. The default is AVERAGE. Lower settings tend to keep the page permanently off-green, at which point people stop reading it.
653
+ */
654
+ post: operations["create-status-page-component"];
655
+ delete?: never;
656
+ options?: never;
657
+ head?: never;
658
+ patch?: never;
659
+ trace?: never;
660
+ };
661
+ "/api/v1/status-page/components/{componentId}": {
662
+ parameters: {
663
+ query?: never;
664
+ header?: never;
665
+ path: {
666
+ componentId: string;
667
+ };
668
+ cookie?: never;
669
+ };
670
+ /** Get a component */
671
+ get: operations["get-status-page-component"];
672
+ /**
673
+ * Update a component
674
+ * @description `started_on` cannot be changed: it determines where the availability bar stops showing as unmeasured, and changing it would rewrite history that has already been published.
675
+ */
676
+ put: operations["update-status-page-component"];
677
+ post?: never;
678
+ /**
679
+ * Delete a component
680
+ * @description Its availability history is removed along with it. Passages in already-published notices that refer to it are retained, since customers may already have read them.
681
+ */
682
+ delete: operations["delete-status-page-component"];
683
+ options?: never;
684
+ head?: never;
685
+ patch?: never;
686
+ trace?: never;
687
+ };
688
+ "/api/v1/status-page/components/{componentId}/sources": {
689
+ parameters: {
690
+ query?: never;
691
+ header?: never;
692
+ path: {
693
+ componentId: string;
694
+ };
695
+ cookie?: never;
696
+ };
697
+ /**
698
+ * List the monitored sources bound to a component
699
+ * @description Monitored sources are internal information and **never appear on the public page**.
700
+ */
701
+ get: operations["list-status-page-component-sources"];
702
+ /**
703
+ * Set the complete list of monitored sources for a component
704
+ * @description Submits the **complete** set of sources; anything not listed is unbound.
705
+ *
706
+ * Once bound, alerts on these machines and web checks drive the status of the component automatically: DISASTER and HIGH are reported as a major outage, AVERAGE as a partial outage, and WARNING as degraded performance. Alerts below `auto_status_min_severity` have no effect.
707
+ *
708
+ * `show_url` controls whether the checked address is shown on the public page. It is off by default.
709
+ */
710
+ put: operations["put-status-page-component-sources"];
711
+ post?: never;
712
+ delete?: never;
713
+ options?: never;
714
+ head?: never;
715
+ patch?: never;
716
+ trace?: never;
717
+ };
718
+ "/api/v1/status-page/incidents": {
719
+ parameters: {
720
+ query?: never;
721
+ header?: never;
722
+ path?: never;
723
+ cookie?: never;
724
+ };
725
+ /**
726
+ * List the incident notices on the status page
727
+ * @description These are **customer-facing notices**, distinct from the monitoring incidents under `/incidents`. Nothing from the latter is carried over; the text here is written by your team.
728
+ */
729
+ get: operations["list-status-page-incidents"];
730
+ put?: never;
731
+ /**
732
+ * Publish an incident notice
733
+ * @description Publishing a notice and writing its first update are a single operation: a notice with no updates would appear as a bare title on a page that has already been delivered to readers.
734
+ *
735
+ * `started_at` is when the **incident began**, not when the notice was published. The two are usually minutes to hours apart, and using the publication time would understate the impact window that customers can compare against their own logs. Backfilling a past incident relies on the same field.
736
+ *
737
+ * The statuses given in `components` take effect on the public page immediately and count towards availability.
738
+ */
739
+ post: operations["publish-status-page-incident"];
740
+ delete?: never;
741
+ options?: never;
742
+ head?: never;
743
+ patch?: never;
744
+ trace?: never;
745
+ };
746
+ "/api/v1/status-page/incidents/{incidentId}": {
747
+ parameters: {
748
+ query?: never;
749
+ header?: never;
750
+ path?: never;
751
+ cookie?: never;
752
+ };
753
+ /** Get an incident notice */
754
+ get: operations["get-status-page-incident"];
755
+ put?: never;
756
+ post?: never;
757
+ delete?: never;
758
+ options?: never;
759
+ head?: never;
760
+ patch?: never;
761
+ trace?: never;
762
+ };
763
+ "/api/v1/status-page/incidents/{incidentId}/updates": {
764
+ parameters: {
765
+ query?: never;
766
+ header?: never;
767
+ path?: never;
768
+ cookie?: never;
769
+ };
770
+ get?: never;
771
+ put?: never;
772
+ /**
773
+ * Append an update to an incident notice
774
+ * @description Published updates are never modified; a correction is issued as a new update. Customers may already have forwarded the original, and a silent rewrite would leave the two sides with different histories.
775
+ *
776
+ * `components` lists only the components **being changed** by this update; those not listed keep their current status. Setting `status` to `RESOLVED` returns every component this notice has affected to operational and closes the notice. A closed notice accepts no further updates.
777
+ */
778
+ post: operations["post-status-page-incident-update"];
779
+ delete?: never;
780
+ options?: never;
781
+ head?: never;
782
+ patch?: never;
783
+ trace?: never;
784
+ };
785
+ "/api/v1/status-page/maintenances": {
786
+ parameters: {
787
+ query?: never;
788
+ header?: never;
789
+ path?: never;
790
+ cookie?: never;
791
+ };
792
+ /** List scheduled maintenance */
793
+ get: operations["list-status-page-maintenances"];
794
+ put?: never;
795
+ /**
796
+ * Schedule maintenance
797
+ * @description Maintenance starts and finishes automatically at the scheduled times; nobody needs to be present. While it runs, the affected components are shown as under maintenance and **availability is not reduced** — planned work should not consume the availability you promise to customers, which is the point of announcing it in advance.
798
+ *
799
+ * This is separate from `/maintenance-windows`, which suppresses alerting for a period. This endpoint announces the work to your customers. The two are usually created together: without suppression, restarts during the maintenance raise alerts and mark the components unavailable.
800
+ */
801
+ post: operations["schedule-status-page-maintenance"];
802
+ delete?: never;
803
+ options?: never;
804
+ head?: never;
805
+ patch?: never;
806
+ trace?: never;
807
+ };
808
+ "/api/v1/status-page/maintenances/{maintenanceId}": {
809
+ parameters: {
810
+ query?: never;
811
+ header?: never;
812
+ path?: never;
813
+ cookie?: never;
814
+ };
815
+ /** Get a scheduled maintenance */
816
+ get: operations["get-status-page-maintenance"];
817
+ put?: never;
818
+ post?: never;
819
+ delete?: never;
820
+ options?: never;
821
+ head?: never;
822
+ patch?: never;
823
+ trace?: never;
824
+ };
825
+ "/api/v1/status-page/maintenances/{maintenanceId}/cancel": {
826
+ parameters: {
827
+ query?: never;
828
+ header?: never;
829
+ path?: never;
830
+ cookie?: never;
831
+ };
832
+ get?: never;
833
+ put?: never;
834
+ /**
835
+ * Cancel a maintenance that has not started
836
+ * @description Cancelled rather than deleted, so that readers who saw the announcement have an explanation. Maintenance that has already started cannot be cancelled; finish it early instead.
837
+ */
838
+ post: operations["cancel-status-page-maintenance"];
839
+ delete?: never;
840
+ options?: never;
841
+ head?: never;
842
+ patch?: never;
843
+ trace?: never;
844
+ };
845
+ "/api/v1/status-page/maintenances/{maintenanceId}/complete": {
846
+ parameters: {
847
+ query?: never;
848
+ header?: never;
849
+ path?: never;
850
+ cookie?: never;
851
+ };
852
+ get?: never;
853
+ put?: never;
854
+ /**
855
+ * Finish a running maintenance early
856
+ * @description Optional: maintenance finishes on its own at the scheduled end time. Use this endpoint when the work is done ahead of schedule; the affected components return to operational immediately.
857
+ */
858
+ post: operations["complete-status-page-maintenance"];
859
+ delete?: never;
860
+ options?: never;
861
+ head?: never;
862
+ patch?: never;
863
+ trace?: never;
864
+ };
518
865
  }
519
866
  export type webhooks = Record<string, never>;
520
867
  export interface components {
@@ -535,7 +882,7 @@ export interface components {
535
882
  user_id: string;
536
883
  };
537
884
  MonitoringItemResource: {
538
- /** @description last / avg / min / max 之类 */
885
+ /** @description Such as last, avg, min or max */
539
886
  aggregation_function: string;
540
887
  /** Format: int64 */
541
888
  evaluation_window_seconds: number;
@@ -545,11 +892,11 @@ export interface components {
545
892
  operator: string;
546
893
  /**
547
894
  * Format: double
548
- * @description 只有 threshold_status RESOLVED 时才有
895
+ * @description Present only when `threshold_status` is RESOLVED
549
896
  */
550
897
  threshold: number | null;
551
898
  threshold_status: string;
552
- /** @description 触发那一刻的值,原样存下来的 */
899
+ /** @description The value at the moment of the trigger, stored as collected */
553
900
  value: string;
554
901
  };
555
902
  TagResource: {
@@ -581,13 +928,13 @@ export interface components {
581
928
  /** Format: uuid */
582
929
  id: string;
583
930
  /**
584
- * @description 监控系统是否判定已恢复。它与是否有人了结这条告警是两件事
931
+ * @description Whether monitoring considers the problem recovered. Independent of whether anyone has closed the incident
585
932
  * @enum {string}
586
933
  */
587
934
  incident_status: "PROBLEM" | "RESOLVED";
588
935
  items: components["schemas"]["MonitoringItemResource"][] | null;
589
936
  name: string;
590
- /** @description 触发器配的那行现场数据 */
937
+ /** @description The operational data line configured on the trigger */
591
938
  operational_data: string;
592
939
  /** Format: uuid */
593
940
  project_id: string;
@@ -606,35 +953,35 @@ export interface components {
606
953
  zabbix_event_id: string;
607
954
  };
608
955
  LengthAwarePageIncidentResource: {
609
- /** @description 这一页的内容 */
956
+ /** @description The records in this page */
610
957
  items: components["schemas"]["IncidentResource"][];
611
958
  /**
612
959
  * Format: int64
613
- * @description 这一页最多几条,回显请求里的值
960
+ * @description Maximum records per page, echoing the request
614
961
  */
615
962
  limit: number;
616
963
  /**
617
964
  * Format: int64
618
- * @description 跳过了多少条,回显请求里的值
965
+ * @description Number of records skipped, echoing the request
619
966
  */
620
967
  offset: number;
621
968
  /**
622
969
  * Format: int64
623
- * @description 命中的总条数,不只是这一页
970
+ * @description Total number of matches, not just this page
624
971
  */
625
972
  total: number;
626
973
  };
627
974
  AcknowledgeIncidentRequestBody: {
628
- /** @description 会一并写入监控系统的确认记录 */
975
+ /** @description Also written to the acknowledgement record in the monitoring system */
629
976
  message?: string;
630
977
  };
631
978
  AssignIncidentRequestBody: {
632
- /** @description 不给就用 user id:时间线上要留一个当时的人名副本 */
979
+ /** @description Defaults to the user id. The timeline keeps a copy of the name as it was at the time */
633
980
  assignee_display_name?: string;
634
981
  assignee_user_id?: string;
635
982
  };
636
983
  CloseIncidentRequestBody: {
637
- /** @description reason OTHER 时必填,否则请求会被拒绝 */
984
+ /** @description Required when `reason` is OTHER; the request is rejected otherwise */
638
985
  message?: string;
639
986
  /** @enum {string} */
640
987
  reason: "RECOVERED" | "FIXED" | "FALSE_POSITIVE" | "DUPLICATE" | "NO_ACTION_REQUIRED" | "ACCEPTED_RISK" | "OTHER";
@@ -646,7 +993,7 @@ export interface components {
646
993
  /** @enum {string} */
647
994
  activity_type: "OPENED" | "RECOVERED" | "ACKNOWLEDGED" | "ASSIGNED" | "UNASSIGNED" | "FOLLOWER_ADDED" | "FOLLOWER_REMOVED" | "COMMENT" | "CLOSED" | "REOPENED";
648
995
  actor_display_name: string;
649
- /** @description 操作者;来源为 SYSTEM ZABBIX 时为空 */
996
+ /** @description The operator. Empty when the source is SYSTEM or ZABBIX */
650
997
  actor_user_id: string;
651
998
  close_reason: string;
652
999
  /** Format: uuid */
@@ -659,16 +1006,16 @@ export interface components {
659
1006
  /** @enum {string} */
660
1007
  source: "SYSTEM" | "OPERATOR" | "ZABBIX";
661
1008
  subject_display_name: string;
662
- /** @description 被指派 / 被取消关注的那个人 */
1009
+ /** @description The user who was assigned, or removed from the followers */
663
1010
  subject_user_id: string;
664
1011
  };
665
1012
  SetFollowingRequestBody: {
666
1013
  following: boolean;
667
1014
  };
668
1015
  CursorPageIncidentActivityResource: {
669
- /** @description 这一页的内容 */
1016
+ /** @description The records in this page */
670
1017
  items: components["schemas"]["IncidentActivityResource"][];
671
- /** @description 下一页的游标;为空表示已经到底 */
1018
+ /** @description Cursor for the next page. Empty means the end has been reached */
672
1019
  next_cursor: string;
673
1020
  };
674
1021
  MaintenancePeriodResource: {
@@ -676,24 +1023,24 @@ export interface components {
676
1023
  duration_seconds: number;
677
1024
  /**
678
1025
  * Format: int64
679
- * @description DAILY / WEEKLY:每 N / N
1026
+ * @description DAILY and WEEKLY: every N days or every N weeks
680
1027
  */
681
1028
  every: number;
682
1029
  /** @enum {string} */
683
1030
  kind: "ONCE" | "DAILY" | "WEEKLY";
684
1031
  /**
685
1032
  * Format: int64
686
- * @description DAILY / WEEKLY:当天零点起的秒数,按窗口自己的时区算
1033
+ * @description DAILY and WEEKLY: seconds from midnight, in the timezone of the window
687
1034
  */
688
1035
  start_time_seconds: number;
689
1036
  /**
690
1037
  * Format: date-time
691
- * @description 只有 ONCE
1038
+ * @description Present only for ONCE
692
1039
  */
693
1040
  starts_at: string | null;
694
1041
  /**
695
1042
  * Format: int64
696
- * @description WEEKLY:星期几的位图,**周一是最低位**
1043
+ * @description WEEKLY: bitmap of weekdays, **Monday is the lowest bit**
697
1044
  */
698
1045
  weekdays: number;
699
1046
  };
@@ -708,7 +1055,7 @@ export interface components {
708
1055
  period: components["schemas"]["MaintenancePeriodResource"];
709
1056
  /** Format: uuid */
710
1057
  project_id: string;
711
- /** @description 空表示**整个项目** */
1058
+ /** @description Empty covers the **entire project** */
712
1059
  server_ids: string[] | null;
713
1060
  /** @enum {string} */
714
1061
  sync_status: "PENDING" | "ACTIVE" | "FAILED" | "EXPIRED";
@@ -724,31 +1071,31 @@ export interface components {
724
1071
  duration_seconds?: number;
725
1072
  /**
726
1073
  * Format: int64
727
- * @description DAILY / WEEKLY:每 N / N
1074
+ * @description DAILY and WEEKLY: every N days or every N weeks
728
1075
  */
729
1076
  every?: number;
730
1077
  /** @enum {string} */
731
1078
  kind: "ONCE" | "DAILY" | "WEEKLY";
732
1079
  /**
733
1080
  * Format: int64
734
- * @description DAILY / WEEKLY:当天零点起的秒数,按窗口自己的时区算
1081
+ * @description DAILY and WEEKLY: seconds from midnight, in the timezone of the window
735
1082
  */
736
1083
  start_time_seconds?: number;
737
1084
  /**
738
1085
  * Format: date-time
739
- * @description 只有 ONCE 用得上
1086
+ * @description Used only by ONCE
740
1087
  */
741
1088
  starts_at?: string;
742
1089
  /**
743
1090
  * Format: int64
744
- * @description WEEKLY:星期几的位图,**周一是最低位**
1091
+ * @description WEEKLY: bitmap of weekdays, **Monday is the lowest bit**
745
1092
  */
746
1093
  weekdays?: number;
747
1094
  };
748
1095
  PutMaintenanceWindowRequestBody: {
749
1096
  /**
750
1097
  * Format: date-time
751
- * @description 整条规则的生效区间起点
1098
+ * @description Start of the period in which the rule is effective
752
1099
  */
753
1100
  active_since: string;
754
1101
  /** Format: date-time */
@@ -757,7 +1104,7 @@ export interface components {
757
1104
  name: string;
758
1105
  period: components["schemas"]["MaintenancePeriodRequest"];
759
1106
  server_ids?: string[] | null;
760
- /** @description IANA 名字,比如 Asia/Shanghai;空即用部署配的默认 */
1107
+ /** @description IANA name such as Asia/Shanghai. Empty uses the configured default */
761
1108
  timezone?: string;
762
1109
  };
763
1110
  CountResource: {
@@ -814,7 +1161,7 @@ export interface components {
814
1161
  severity: string;
815
1162
  /** Format: double */
816
1163
  threshold: number;
817
- /** @description 图例上说明这条线是什么 */
1164
+ /** @description Labels the line in the chart legend */
818
1165
  trigger_name: string;
819
1166
  };
820
1167
  MetricResponseBody: {
@@ -823,7 +1170,7 @@ export interface components {
823
1170
  effective_from: string;
824
1171
  /** Format: date-time */
825
1172
  effective_to: string;
826
- /** @description 数据来自趋势表,每个点是一小时的聚合 */
1173
+ /** @description Data comes from hourly aggregates, one point per hour */
827
1174
  from_trends: boolean;
828
1175
  series: components["schemas"]["MetricSeriesResource"][] | null;
829
1176
  thresholds: components["schemas"]["ItemThresholdResource"][] | null;
@@ -839,7 +1186,7 @@ export interface components {
839
1186
  };
840
1187
  ServerResourcesResource: {
841
1188
  interfaces: components["schemas"]["HostInterfaceResource"][] | null;
842
- /** @description 自动采集的硬件与系统清单:CPU、内存、操作系统等 */
1189
+ /** @description Hardware and system inventory collected automatically: CPU, memory, operating system and so on */
843
1190
  inventory: {
844
1191
  [key: string]: string;
845
1192
  };
@@ -848,7 +1195,7 @@ export interface components {
848
1195
  SnapshotResource: {
849
1196
  agent_error: string;
850
1197
  /**
851
- * @description AGENT_DOWN agent 不通但机器还活着;UNREACHABLE 是连这一点都说不上
1198
+ * @description AGENT_DOWN means the agent is unreachable while the machine is still alive; UNREACHABLE means neither can be established
852
1199
  * @enum {string}
853
1200
  */
854
1201
  agent_reachability: "UNKNOWN" | "REACHABLE" | "AGENT_DOWN" | "UNREACHABLE";
@@ -892,7 +1239,7 @@ export interface components {
892
1239
  id: string;
893
1240
  last_error: string;
894
1241
  /**
895
- * @description FAILED 时看 last_error
1242
+ * @description Consult `last_error` when this is FAILED
896
1243
  * @enum {string}
897
1244
  */
898
1245
  monitoring_status: "PENDING" | "ACTIVE" | "DISABLED" | "FAILED";
@@ -902,30 +1249,30 @@ export interface components {
902
1249
  templates: components["schemas"]["ServerTemplateResource"][] | null;
903
1250
  /** Format: date-time */
904
1251
  updated_at: string;
905
- /** @description agent 配置里的 Hostname 必须与它一致,主动式采集靠它认人 */
1252
+ /** @description The Hostname in the agent configuration must match this value; active checks identify the machine by it */
906
1253
  zabbix_host_name: string;
907
1254
  };
908
1255
  LengthAwarePageServerResource: {
909
- /** @description 这一页的内容 */
1256
+ /** @description The records in this page */
910
1257
  items: components["schemas"]["ServerResource"][];
911
1258
  /**
912
1259
  * Format: int64
913
- * @description 这一页最多几条,回显请求里的值
1260
+ * @description Maximum records per page, echoing the request
914
1261
  */
915
1262
  limit: number;
916
1263
  /**
917
1264
  * Format: int64
918
- * @description 跳过了多少条,回显请求里的值
1265
+ * @description Number of records skipped, echoing the request
919
1266
  */
920
1267
  offset: number;
921
1268
  /**
922
1269
  * Format: int64
923
- * @description 命中的总条数,不只是这一页
1270
+ * @description Total number of matches, not just this page
924
1271
  */
925
1272
  total: number;
926
1273
  };
927
1274
  TemplateBindingRequest: {
928
- /** @description 模板自己声明的参数,密钥参数写明文,返回时只报名字 */
1275
+ /** @description Parameters declared by the template. Secret parameters are supplied in clear text and returned by name only */
929
1276
  parameters?: {
930
1277
  [key: string]: string;
931
1278
  };
@@ -937,13 +1284,13 @@ export interface components {
937
1284
  /** @enum {string} */
938
1285
  address_kind: "ip" | "dns";
939
1286
  /**
940
- * @description 空即被动式:它对 agent 侧配置要求最少
1287
+ * @description Empty selects passive mode, which requires the least agent-side configuration
941
1288
  * @enum {string}
942
1289
  */
943
1290
  agent_mode?: "PASSIVE" | "ACTIVE";
944
1291
  /**
945
1292
  * Format: int64
946
- * @description 0 表示用默认的 10050
1293
+ * @description 0 uses the default of 10050
947
1294
  */
948
1295
  agent_port?: number;
949
1296
  description?: string;
@@ -951,14 +1298,14 @@ export interface components {
951
1298
  template_bindings?: components["schemas"]["TemplateBindingRequest"][] | null;
952
1299
  };
953
1300
  EnrollmentResource: {
954
- /** @description PSK,与 tls_psk 一样只出现这一次 */
1301
+ /** @description Includes the PSK. Like `tls_psk`, it is returned only this once */
955
1302
  install_command: string;
956
1303
  install_script_url: string;
957
- /** @description **只出现这一次** */
1304
+ /** @description **Returned only this once** */
958
1305
  tls_psk: string;
959
1306
  tls_psk_identity: string;
960
1307
  zabbix_host_name: string;
961
- /** @description agent 配置里的 Server / ServerActive */
1308
+ /** @description The Server and ServerActive values for the agent configuration */
962
1309
  zabbix_server_address: string;
963
1310
  };
964
1311
  ServerEnrollmentResponseBody: {
@@ -968,12 +1315,12 @@ export interface components {
968
1315
  UpdateServerRequestBody: {
969
1316
  address?: string;
970
1317
  /**
971
- * @description 要改地址就必须和 address 一起给
1318
+ * @description Must be supplied together with `address` when changing the address
972
1319
  * @enum {string}
973
1320
  */
974
1321
  address_kind?: "ip" | "dns";
975
1322
  /**
976
- * @description 改采集模式会把全部模板换成另一个变体
1323
+ * @description Changing the collection mode rebinds every template to the corresponding variant
977
1324
  * @enum {string}
978
1325
  */
979
1326
  agent_mode?: "PASSIVE" | "ACTIVE";
@@ -989,7 +1336,7 @@ export interface components {
989
1336
  error: string;
990
1337
  /**
991
1338
  * Format: int64
992
- * @description 第几步失败的,从 1 数;healthy 时为 0
1339
+ * @description Index of the failed step, counting from 1. 0 when healthy
993
1340
  */
994
1341
  failed_step: number;
995
1342
  healthy: boolean;
@@ -999,7 +1346,7 @@ export interface components {
999
1346
  response_time_seconds: number;
1000
1347
  };
1001
1348
  WebCheckStepResource: {
1002
- /** @description 状态码表达式,比如 200 或者 200,301-302 */
1349
+ /** @description Status code expression, such as 200 or 200,301-302 */
1003
1350
  expected_status_codes: string;
1004
1351
  follow_redirects: boolean;
1005
1352
  name: string;
@@ -1014,7 +1361,7 @@ export interface components {
1014
1361
  last_error: string;
1015
1362
  /** Format: int64 */
1016
1363
  response_time_threshold_seconds: number;
1017
- /** @description null 表示这个检查还一轮都没跑过。零值会把「还不知道」显示成「响应 0 秒、状态码 0 */
1364
+ /** @description null means the check has not completed a round yet. A zero value would present "not yet known" as "0 seconds, status code 0" */
1018
1365
  result: components["schemas"]["WebCheckResultResource"] | null;
1019
1366
  /** Format: int64 */
1020
1367
  retries: number;
@@ -1027,23 +1374,23 @@ export interface components {
1027
1374
  timeout_seconds: number;
1028
1375
  };
1029
1376
  WebCheckStepRequest: {
1030
- /** @description 状态码表达式,比如 200 或者 200,301-302;留空表示不检查状态码 */
1377
+ /** @description Status code expression, such as 200 or 200,301-302. Empty disables status code checking */
1031
1378
  expected_status_codes?: string;
1032
1379
  follow_redirects?: boolean;
1033
1380
  name: string;
1034
- /** @description 响应体里必须出现的字符串 */
1381
+ /** @description A string that must appear in the response body */
1035
1382
  required_pattern?: string;
1036
1383
  url: string;
1037
1384
  };
1038
1385
  PutWebCheckRequestBody: {
1039
1386
  /**
1040
1387
  * Format: int64
1041
- * @description 0 表示用默认
1388
+ * @description 0 uses the default
1042
1389
  */
1043
1390
  interval_seconds?: number;
1044
1391
  /**
1045
1392
  * Format: int64
1046
- * @description 超过它算慢,0 表示不看响应时间
1393
+ * @description Slower than this counts as slow. 0 disables the response time check
1047
1394
  */
1048
1395
  response_time_threshold_seconds?: number;
1049
1396
  /** Format: int64 */
@@ -1060,19 +1407,19 @@ export interface components {
1060
1407
  downtime_seconds: number;
1061
1408
  /**
1062
1409
  * Format: int64
1063
- * @description 为负表示这个周期的额度已经超支
1410
+ * @description A negative value means the budget for this period is already exhausted
1064
1411
  */
1065
1412
  error_budget_seconds: number;
1066
1413
  /**
1067
1414
  * Format: int64
1068
- * @description 被计划内维护排除掉的那部分
1415
+ * @description The portion excluded by planned maintenance
1069
1416
  */
1070
1417
  excluded_downtime_seconds: number;
1071
1418
  /** Format: date-time */
1072
1419
  period_from: string;
1073
1420
  /** Format: date-time */
1074
1421
  period_to: string;
1075
- /** @description 空表示这一行是项目整体 */
1422
+ /** @description Empty means this row covers the project as a whole */
1076
1423
  server_id: string;
1077
1424
  /** Format: double */
1078
1425
  sli_percent: number;
@@ -1089,7 +1436,7 @@ export interface components {
1089
1436
  start_time_seconds: number;
1090
1437
  /**
1091
1438
  * Format: int64
1092
- * @description 星期几的位图,**周一是最低位**,与维护窗口同一套编码
1439
+ * @description Bitmap of weekdays, **Monday is the lowest bit**, using the same encoding as maintenance windows
1093
1440
  */
1094
1441
  weekdays: number;
1095
1442
  };
@@ -1104,13 +1451,13 @@ export interface components {
1104
1451
  period: "DAILY" | "WEEKLY" | "MONTHLY" | "QUARTERLY" | "ANNUALLY";
1105
1452
  /** Format: uuid */
1106
1453
  project_id: string;
1107
- /** @description 空表示 7×24 全天候承诺 */
1454
+ /** @description Empty means a 24x7 commitment */
1108
1455
  schedule: components["schemas"]["ScheduleWindowResource"][] | null;
1109
1456
  /** Format: uuid */
1110
1457
  slo_id: string;
1111
1458
  /**
1112
1459
  * Format: double
1113
- * @description 目标可用率,比如 99.9
1460
+ * @description Target availability, such as 99.9
1114
1461
  */
1115
1462
  slo_percent: number;
1116
1463
  /** @enum {string} */
@@ -1124,7 +1471,7 @@ export interface components {
1124
1471
  start_time_seconds?: number;
1125
1472
  /**
1126
1473
  * Format: int64
1127
- * @description 星期几的位图,**周一是最低位**(1=周一 … 64=周日)
1474
+ * @description Bitmap of weekdays, **Monday is the lowest bit** (1 = Monday … 64 = Sunday)
1128
1475
  */
1129
1476
  weekdays: number;
1130
1477
  };
@@ -1135,7 +1482,7 @@ export interface components {
1135
1482
  min_severity: "ANY" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
1136
1483
  name: string;
1137
1484
  /**
1138
- * @description 空即按月
1485
+ * @description Empty selects monthly
1139
1486
  * @enum {string}
1140
1487
  */
1141
1488
  period?: "DAILY" | "WEEKLY" | "MONTHLY" | "QUARTERLY" | "ANNUALLY";
@@ -1144,42 +1491,392 @@ export interface components {
1144
1491
  slo_id: string;
1145
1492
  /**
1146
1493
  * Format: double
1147
- * @description 目标可用率,比如 99.9;最多四位小数
1494
+ * @description Target availability, such as 99.9. At most four decimal places
1148
1495
  */
1149
1496
  slo_percent: number;
1150
- /** @description 决定统计周期的边界,即每个周期从哪一刻开始 */
1497
+ /** @description Determines the boundaries of each reporting period, that is, the moment each period begins */
1151
1498
  timezone?: string;
1152
1499
  };
1153
- };
1154
- responses: never;
1155
- parameters: never;
1156
- requestBodies: never;
1157
- headers: never;
1158
- pathItems: never;
1500
+ StatusPageResource: {
1501
+ /** @description #RRGGBB */
1502
+ brand_color: string;
1503
+ /** Format: date-time */
1504
+ created_at: string;
1505
+ /** @description The custom domain bound to this page. Empty means it is served only at /{slug} under the shared domain */
1506
+ custom_domain: string;
1507
+ footer_text: string;
1508
+ headline: string;
1509
+ logo_url: string;
1510
+ name: string;
1511
+ /** @description The current public address of this page. It is returned even while unpublished, in which case opening it returns 404 */
1512
+ public_url: string;
1513
+ published: boolean;
1514
+ /** @description Whether search engines may index the page */
1515
+ search_engine_index: boolean;
1516
+ slug: string;
1517
+ /** Format: uuid */
1518
+ status_page_id: string;
1519
+ support_url: string;
1520
+ /** @enum {string} */
1521
+ theme: "AUTO" | "LIGHT" | "DARK";
1522
+ /** @description Determines where the day boundary falls on the availability bar */
1523
+ timezone: string;
1524
+ /** Format: date-time */
1525
+ updated_at: string;
1526
+ /**
1527
+ * Format: int64
1528
+ * @description Number of days covered by the availability bar
1529
+ */
1530
+ uptime_days: number;
1531
+ };
1532
+ PutStatusPageRequestBody: {
1533
+ /** @description #RRGGBB. Applied to the page styling; only a strict six-digit hexadecimal value is accepted */
1534
+ brand_color?: string;
1535
+ /** @description Your own domain, such as status.acme.com. Empty binds none. Globally unique */
1536
+ custom_domain?: string;
1537
+ /** @description The line of free-form text in the page footer. Plain text */
1538
+ footer_text?: string;
1539
+ /** @description The line shown below the title */
1540
+ headline?: string;
1541
+ logo_url?: string;
1542
+ /** @description Page title */
1543
+ name: string;
1544
+ /**
1545
+ * @description While false, the public address returns 404. Unpublished by default
1546
+ * @default false
1547
+ */
1548
+ published?: boolean;
1549
+ /**
1550
+ * @description Not indexed by default. Once a page has been crawled, switching back does not remove copies already held in third-party indexes
1551
+ * @default false
1552
+ */
1553
+ search_engine_index?: boolean;
1554
+ /** @description The address segment under the shared domain. Lowercase letters, digits and hyphens. Globally unique */
1555
+ slug: string;
1556
+ support_url?: string;
1557
+ /**
1558
+ * @default AUTO
1559
+ * @enum {string}
1560
+ */
1561
+ theme?: "AUTO" | "LIGHT" | "DARK";
1562
+ /** @description IANA name. Empty selects UTC */
1563
+ timezone?: string;
1564
+ /**
1565
+ * Format: int64
1566
+ * @default 90
1567
+ */
1568
+ uptime_days?: number;
1569
+ };
1570
+ PutStatusPageOrderRequestBody: {
1571
+ items: components["schemas"]["StatusPageOrderItem"][];
1572
+ };
1573
+ /** @description Exactly one of the two: `group_id` marks this position as a group, `component_id` as an ungrouped component */
1574
+ StatusPageOrderItem: {
1575
+ /** Format: uuid */
1576
+ component_id?: string;
1577
+ /** Format: uuid */
1578
+ group_id?: string;
1579
+ };
1580
+ PutStatusPageGroupOrderRequestBody: {
1581
+ component_ids: string[];
1582
+ };
1583
+ StatusPageGroupResource: {
1584
+ /** @description Whether the group is collapsed by default on the page */
1585
+ collapsed: boolean;
1586
+ /** Format: date-time */
1587
+ created_at: string;
1588
+ description: string;
1589
+ /** Format: uuid */
1590
+ group_id: string;
1591
+ name: string;
1592
+ /** Format: int64 */
1593
+ position: number;
1594
+ };
1595
+ StatusPageGroupListResponseBody: {
1596
+ data: components["schemas"]["StatusPageGroupResource"][];
1597
+ };
1598
+ PutStatusPageGroupRequestBody: {
1599
+ /** @default true */
1600
+ collapsed?: boolean;
1601
+ description?: string;
1602
+ name: string;
1603
+ };
1604
+ StatusPageComponentResource: {
1605
+ /** @enum {string} */
1606
+ auto_status_min_severity: "ANY" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
1607
+ /** Format: uuid */
1608
+ component_id: string;
1609
+ /** Format: date-time */
1610
+ created_at: string;
1611
+ /**
1612
+ * @description The status currently shown to the public. OPERATIONAL means normal
1613
+ * @enum {string}
1614
+ */
1615
+ current_status: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
1616
+ description: string;
1617
+ /** @description Empty means ungrouped, placed directly at the top level of the page */
1618
+ group_id: string;
1619
+ name: string;
1620
+ /** @description Hide this row while everything is normal */
1621
+ only_show_if_degraded: boolean;
1622
+ /** Format: int64 */
1623
+ position: number;
1624
+ /** @description Whether the availability bar is shown. Components with this disabled are also excluded from the aggregate of their group */
1625
+ show_uptime: boolean;
1626
+ /**
1627
+ * Format: date-time
1628
+ * @description The moment this component started being covered. Earlier days are shown as unmeasured rather than operational
1629
+ */
1630
+ started_on: string;
1631
+ /**
1632
+ * Format: double
1633
+ * @description Availability over the past `uptime_days` days
1634
+ */
1635
+ uptime_percent: number;
1636
+ };
1637
+ StatusPageComponentListResponseBody: {
1638
+ data: components["schemas"]["StatusPageComponentResource"][];
1639
+ };
1640
+ PutStatusPageComponentRequestBody: {
1641
+ /**
1642
+ * @description Alerts below this severity do not change the status of this row
1643
+ * @default AVERAGE
1644
+ * @enum {string}
1645
+ */
1646
+ auto_status_min_severity?: "ANY" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
1647
+ description?: string;
1648
+ /**
1649
+ * Format: uuid
1650
+ * @description Empty leaves the component ungrouped
1651
+ */
1652
+ group_id?: string;
1653
+ /** @description Customer-facing copy; appears verbatim on the public page */
1654
+ name: string;
1655
+ /** @default false */
1656
+ only_show_if_degraded?: boolean;
1657
+ /** @default true */
1658
+ show_uptime?: boolean;
1659
+ /**
1660
+ * Format: date-time
1661
+ * @description Meaningful only at creation and immutable afterwards. Empty selects the current moment
1662
+ */
1663
+ started_on?: string;
1664
+ };
1665
+ StatusPageComponentSourceServer: {
1666
+ /** Format: uuid */
1667
+ server_id: string;
1668
+ };
1669
+ StatusPageComponentSourceWebCheck: {
1670
+ /**
1671
+ * @description Whether the checked address is shown on the public page
1672
+ * @default false
1673
+ */
1674
+ show_url?: boolean;
1675
+ /** Format: uuid */
1676
+ web_check_id: string;
1677
+ };
1678
+ StatusPageComponentSourcesResource: {
1679
+ servers: components["schemas"]["StatusPageComponentSourceServer"][];
1680
+ web_checks: components["schemas"]["StatusPageComponentSourceWebCheck"][];
1681
+ };
1682
+ /** @description Submits the complete set; anything not listed is unbound */
1683
+ PutStatusPageComponentSourcesRequestBody: {
1684
+ servers?: components["schemas"]["StatusPageComponentSourceServer"][];
1685
+ web_checks?: components["schemas"]["StatusPageComponentSourceWebCheck"][];
1686
+ };
1687
+ /** @description A status transition of one component within one update. The component name is a snapshot taken at the time */
1688
+ StatusPageIncidentComponentResource: {
1689
+ /** Format: uuid */
1690
+ component_id: string;
1691
+ component_name: string;
1692
+ /** @enum {string} */
1693
+ new_status: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
1694
+ /** @enum {string} */
1695
+ old_status: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
1696
+ };
1697
+ StatusPageIncidentUpdateResource: {
1698
+ affected_components: components["schemas"]["StatusPageIncidentComponentResource"][] | null;
1699
+ /** @description Body text. Plain text */
1700
+ body: string;
1701
+ /** @enum {string} */
1702
+ incident_status: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
1703
+ /** Format: date-time */
1704
+ published_at: string;
1705
+ /** Format: uuid */
1706
+ update_id: string;
1707
+ };
1708
+ StatusPageIncidentResource: {
1709
+ /** @enum {string} */
1710
+ impact: "NONE" | "MINOR" | "MAJOR" | "CRITICAL";
1711
+ /** Format: uuid */
1712
+ incident_id: string;
1713
+ /** @enum {string} */
1714
+ incident_status: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
1715
+ name: string;
1716
+ /** Format: date-time */
1717
+ published_at: string;
1718
+ /** Format: date-time */
1719
+ resolved_at: string | null;
1720
+ /**
1721
+ * Format: date-time
1722
+ * @description When the incident began, not when the notice was published
1723
+ */
1724
+ started_at: string;
1725
+ /** @description Most recently published first */
1726
+ updates: components["schemas"]["StatusPageIncidentUpdateResource"][] | null;
1727
+ };
1728
+ LengthAwarePageStatusPageIncidentResource: {
1729
+ data: components["schemas"]["StatusPageIncidentResource"][];
1730
+ /** Format: int64 */
1731
+ limit: number;
1732
+ /** Format: int64 */
1733
+ offset: number;
1734
+ /** Format: int64 */
1735
+ total: number;
1736
+ };
1737
+ StatusPageIncidentComponentRequest: {
1738
+ /** Format: uuid */
1739
+ component_id: string;
1740
+ /**
1741
+ * @description Empty returns this component to operational
1742
+ * @enum {string}
1743
+ */
1744
+ status?: "OPERATIONAL" | "DEGRADED_PERFORMANCE" | "PARTIAL_OUTAGE" | "MAJOR_OUTAGE" | "UNDER_MAINTENANCE";
1745
+ };
1746
+ PublishStatusPageIncidentRequestBody: {
1747
+ /** @description Body of the first update. Plain text */
1748
+ body: string;
1749
+ components?: components["schemas"]["StatusPageIncidentComponentRequest"][];
1750
+ /**
1751
+ * @description Empty derives the impact from the affected components
1752
+ * @enum {string}
1753
+ */
1754
+ impact?: "NONE" | "MINOR" | "MAJOR" | "CRITICAL";
1755
+ /**
1756
+ * @default INVESTIGATING
1757
+ * @enum {string}
1758
+ */
1759
+ incident_status?: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
1760
+ /** @description The public title */
1761
+ name: string;
1762
+ /**
1763
+ * Format: date-time
1764
+ * @description Empty selects the current moment. Backfilling a past incident sets it in the past
1765
+ */
1766
+ published_at?: string;
1767
+ /**
1768
+ * Format: date-time
1769
+ * @description When the incident began. Empty uses the publication time
1770
+ */
1771
+ started_at?: string;
1772
+ };
1773
+ PostStatusPageIncidentUpdateRequestBody: {
1774
+ /** @description Body text. Plain text */
1775
+ body: string;
1776
+ /** @description Lists only the components being changed by this update; those not listed keep their current status */
1777
+ components?: components["schemas"]["StatusPageIncidentComponentRequest"][];
1778
+ /**
1779
+ * @description Empty keeps the current stage. RESOLVED closes the notice and returns every affected component to operational
1780
+ * @enum {string}
1781
+ */
1782
+ incident_status?: "INVESTIGATING" | "IDENTIFIED" | "MONITORING" | "RESOLVED";
1783
+ /** Format: date-time */
1784
+ published_at?: string;
1785
+ };
1786
+ StatusPageMaintenanceComponentResource: {
1787
+ /** Format: uuid */
1788
+ component_id: string;
1789
+ component_name: string;
1790
+ /** @enum {string} */
1791
+ component_status: "UNDER_MAINTENANCE" | "DEGRADED_PERFORMANCE";
1792
+ };
1793
+ StatusPageMaintenanceResource: {
1794
+ affected_components: components["schemas"]["StatusPageMaintenanceComponentResource"][] | null;
1795
+ /** @description Maintenance description. Plain text */
1796
+ body: string;
1797
+ /**
1798
+ * Format: date-time
1799
+ * @description When the maintenance actually finished
1800
+ */
1801
+ completed_at: string | null;
1802
+ /** Format: uuid */
1803
+ maintenance_id: string;
1804
+ /** @enum {string} */
1805
+ maintenance_status: "SCHEDULED" | "IN_PROGRESS" | "COMPLETED" | "CANCELLED";
1806
+ name: string;
1807
+ /** Format: date-time */
1808
+ scheduled_for: string;
1809
+ /** Format: date-time */
1810
+ scheduled_until: string;
1811
+ /**
1812
+ * Format: date-time
1813
+ * @description When the maintenance actually started, which may differ from the scheduled time
1814
+ */
1815
+ started_at: string | null;
1816
+ };
1817
+ LengthAwarePageStatusPageMaintenanceResource: {
1818
+ data: components["schemas"]["StatusPageMaintenanceResource"][];
1819
+ /** Format: int64 */
1820
+ limit: number;
1821
+ /** Format: int64 */
1822
+ offset: number;
1823
+ /** Format: int64 */
1824
+ total: number;
1825
+ };
1826
+ StatusPageMaintenanceComponentRequest: {
1827
+ /** Format: uuid */
1828
+ component_id: string;
1829
+ /**
1830
+ * @description How this component is shown while the maintenance runs. Neither value reduces availability
1831
+ * @default UNDER_MAINTENANCE
1832
+ * @enum {string}
1833
+ */
1834
+ component_status?: "UNDER_MAINTENANCE" | "DEGRADED_PERFORMANCE";
1835
+ };
1836
+ ScheduleStatusPageMaintenanceRequestBody: {
1837
+ /** @description Maintenance description. Plain text */
1838
+ body: string;
1839
+ /** @description At least one. Maintenance that affects no component reads on the page as an announcement with no subject */
1840
+ components: components["schemas"]["StatusPageMaintenanceComponentRequest"][];
1841
+ name: string;
1842
+ /** Format: date-time */
1843
+ scheduled_for: string;
1844
+ /**
1845
+ * Format: date-time
1846
+ * @description Must be later than `scheduled_for`
1847
+ */
1848
+ scheduled_until: string;
1849
+ };
1850
+ };
1851
+ responses: never;
1852
+ parameters: never;
1853
+ requestBodies: never;
1854
+ headers: never;
1855
+ pathItems: never;
1159
1856
  }
1160
1857
  export type $defs = Record<string, never>;
1161
1858
  export interface operations {
1162
1859
  "list-incidents": {
1163
1860
  parameters: {
1164
1861
  query?: {
1165
- /** @description 这一页最多返回多少条 */
1862
+ /** @description Maximum number of records in this page */
1166
1863
  limit?: number;
1167
- /** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
1864
+ /** @description Number of records to skip. For deeper paging, use the cursor-paged endpoint instead */
1168
1865
  offset?: number;
1169
- /** @description 只看某一台机器的 */
1866
+ /** @description Restrict to a single machine */
1170
1867
  server_id?: string;
1171
1868
  incident_status?: "PROBLEM" | "RESOLVED";
1172
- /** @description 按不低于该等级匹配,而非精确匹配 */
1869
+ /** @description Matches at or above this severity, not exactly this severity */
1173
1870
  min_severity?: "NOT_CLASSIFIED" | "INFORMATION" | "WARNING" | "AVERAGE" | "HIGH" | "DISASTER";
1174
1871
  started_after?: string;
1175
1872
  started_before?: string;
1176
- /** @description [active_from, active_to] **有交集**的告警,给指标图叠加故障区间要的是这个 */
1873
+ /** @description Incidents that **overlap** [active_from, active_to]. This is what you want when overlaying incident bands on a metric chart */
1177
1874
  active_from?: string;
1178
1875
  active_to?: string;
1179
- /** @description 形如 key key=value,可重复;多个标签之间是与关系 */
1876
+ /** @description Given as `key` or `key=value`, repeatable. Multiple tags are combined with AND */
1180
1877
  tag?: string[] | null;
1181
1878
  assignee_user_id?: string;
1182
- /** @description 有没有人在这边把它处理完,与 incident_status 无关 */
1879
+ /** @description Whether someone has finished handling it here. Independent of `incident_status` */
1183
1880
  closed?: "true" | "false";
1184
1881
  acknowledged?: "true" | "false";
1185
1882
  unassigned?: "true" | "false";
@@ -1452,7 +2149,7 @@ export interface operations {
1452
2149
  parameters: {
1453
2150
  query?: {
1454
2151
  limit?: number;
1455
- /** @description 上一页返回的 next_cursor,空即从头开始 */
2152
+ /** @description The `next_cursor` returned by the previous page. Empty starts from the beginning */
1456
2153
  cursor?: string;
1457
2154
  };
1458
2155
  header?: never;
@@ -1512,16 +2209,824 @@ export interface operations {
1512
2209
  };
1513
2210
  };
1514
2211
  };
1515
- "get-maintenance-window": {
2212
+ "get-maintenance-window": {
2213
+ parameters: {
2214
+ query?: never;
2215
+ header?: never;
2216
+ path: {
2217
+ windowId: string;
2218
+ };
2219
+ cookie?: never;
2220
+ };
2221
+ requestBody?: never;
2222
+ responses: {
2223
+ /** @description OK */
2224
+ 200: {
2225
+ headers: {
2226
+ [name: string]: unknown;
2227
+ };
2228
+ content: {
2229
+ "application/json": components["schemas"]["MaintenanceWindowResource"];
2230
+ };
2231
+ };
2232
+ /** @description Error */
2233
+ default: {
2234
+ headers: {
2235
+ [name: string]: unknown;
2236
+ };
2237
+ content: {
2238
+ "application/json": components["schemas"]["Error"];
2239
+ };
2240
+ };
2241
+ };
2242
+ };
2243
+ "put-maintenance-window": {
2244
+ parameters: {
2245
+ query?: never;
2246
+ header?: never;
2247
+ path: {
2248
+ windowId: string;
2249
+ };
2250
+ cookie?: never;
2251
+ };
2252
+ requestBody: {
2253
+ content: {
2254
+ "application/json": components["schemas"]["PutMaintenanceWindowRequestBody"];
2255
+ };
2256
+ };
2257
+ responses: {
2258
+ /** @description OK */
2259
+ 200: {
2260
+ headers: {
2261
+ [name: string]: unknown;
2262
+ };
2263
+ content: {
2264
+ "application/json": components["schemas"]["MaintenanceWindowResource"];
2265
+ };
2266
+ };
2267
+ /** @description Error */
2268
+ default: {
2269
+ headers: {
2270
+ [name: string]: unknown;
2271
+ };
2272
+ content: {
2273
+ "application/json": components["schemas"]["Error"];
2274
+ };
2275
+ };
2276
+ };
2277
+ };
2278
+ "delete-maintenance-window": {
2279
+ parameters: {
2280
+ query?: never;
2281
+ header?: never;
2282
+ path: {
2283
+ windowId: string;
2284
+ };
2285
+ cookie?: never;
2286
+ };
2287
+ requestBody?: never;
2288
+ responses: {
2289
+ /** @description No Content */
2290
+ 204: {
2291
+ headers: {
2292
+ [name: string]: unknown;
2293
+ };
2294
+ content?: never;
2295
+ };
2296
+ /** @description Error */
2297
+ default: {
2298
+ headers: {
2299
+ [name: string]: unknown;
2300
+ };
2301
+ content: {
2302
+ "application/json": components["schemas"]["Error"];
2303
+ };
2304
+ };
2305
+ };
2306
+ };
2307
+ "get-project-overview": {
2308
+ parameters: {
2309
+ query?: never;
2310
+ header?: never;
2311
+ path?: never;
2312
+ cookie?: never;
2313
+ };
2314
+ requestBody?: never;
2315
+ responses: {
2316
+ /** @description OK */
2317
+ 200: {
2318
+ headers: {
2319
+ [name: string]: unknown;
2320
+ };
2321
+ content: {
2322
+ "application/json": components["schemas"]["ProjectOverviewResource"];
2323
+ };
2324
+ };
2325
+ /** @description Error */
2326
+ default: {
2327
+ headers: {
2328
+ [name: string]: unknown;
2329
+ };
2330
+ content: {
2331
+ "application/json": components["schemas"]["Error"];
2332
+ };
2333
+ };
2334
+ };
2335
+ };
2336
+ "list-server-items": {
2337
+ parameters: {
2338
+ query?: {
2339
+ /** @description Fuzzy match on key or name */
2340
+ keyword?: string;
2341
+ /** @description Given as `key` or `key=value`, repeatable. The `component` tags applied by the official templates (cpu, memory, filesystem and so on) are filtered through this */
2342
+ tag?: string[] | null;
2343
+ };
2344
+ header?: never;
2345
+ path: {
2346
+ serverId: string;
2347
+ };
2348
+ cookie?: never;
2349
+ };
2350
+ requestBody?: never;
2351
+ responses: {
2352
+ /** @description OK */
2353
+ 200: {
2354
+ headers: {
2355
+ [name: string]: unknown;
2356
+ };
2357
+ content: {
2358
+ "application/json": components["schemas"]["ItemListResponseBody"];
2359
+ };
2360
+ };
2361
+ /** @description Error */
2362
+ default: {
2363
+ headers: {
2364
+ [name: string]: unknown;
2365
+ };
2366
+ content: {
2367
+ "application/json": components["schemas"]["Error"];
2368
+ };
2369
+ };
2370
+ };
2371
+ };
2372
+ "get-server-metric": {
2373
+ parameters: {
2374
+ query?: {
2375
+ /** @description **Prefix match**: `vfs.fs.size` returns one series per mount point. Supply this or `item_id` */
2376
+ item_key?: string;
2377
+ item_id?: string;
2378
+ /** @description Defaults to one hour ago */
2379
+ from?: string;
2380
+ to?: string;
2381
+ /** @description Number of downsampling buckets. 0 returns the collected data points unchanged */
2382
+ max_points?: number;
2383
+ /** @description Also return the thresholds currently in effect for these items */
2384
+ include_thresholds?: boolean;
2385
+ };
2386
+ header?: never;
2387
+ path: {
2388
+ serverId: string;
2389
+ };
2390
+ cookie?: never;
2391
+ };
2392
+ requestBody?: never;
2393
+ responses: {
2394
+ /** @description OK */
2395
+ 200: {
2396
+ headers: {
2397
+ [name: string]: unknown;
2398
+ };
2399
+ content: {
2400
+ "application/json": components["schemas"]["MetricResponseBody"];
2401
+ };
2402
+ };
2403
+ /** @description Error */
2404
+ default: {
2405
+ headers: {
2406
+ [name: string]: unknown;
2407
+ };
2408
+ content: {
2409
+ "application/json": components["schemas"]["Error"];
2410
+ };
2411
+ };
2412
+ };
2413
+ };
2414
+ "get-server-resources": {
2415
+ parameters: {
2416
+ query?: never;
2417
+ header?: never;
2418
+ path: {
2419
+ serverId: string;
2420
+ };
2421
+ cookie?: never;
2422
+ };
2423
+ requestBody?: never;
2424
+ responses: {
2425
+ /** @description OK */
2426
+ 200: {
2427
+ headers: {
2428
+ [name: string]: unknown;
2429
+ };
2430
+ content: {
2431
+ "application/json": components["schemas"]["ServerResourcesResource"];
2432
+ };
2433
+ };
2434
+ /** @description Error */
2435
+ default: {
2436
+ headers: {
2437
+ [name: string]: unknown;
2438
+ };
2439
+ content: {
2440
+ "application/json": components["schemas"]["Error"];
2441
+ };
2442
+ };
2443
+ };
2444
+ };
2445
+ "get-server-snapshot": {
2446
+ parameters: {
2447
+ query?: never;
2448
+ header?: never;
2449
+ path: {
2450
+ serverId: string;
2451
+ };
2452
+ cookie?: never;
2453
+ };
2454
+ requestBody?: never;
2455
+ responses: {
2456
+ /** @description OK */
2457
+ 200: {
2458
+ headers: {
2459
+ [name: string]: unknown;
2460
+ };
2461
+ content: {
2462
+ "application/json": components["schemas"]["SnapshotResource"];
2463
+ };
2464
+ };
2465
+ /** @description Error */
2466
+ default: {
2467
+ headers: {
2468
+ [name: string]: unknown;
2469
+ };
2470
+ content: {
2471
+ "application/json": components["schemas"]["Error"];
2472
+ };
2473
+ };
2474
+ };
2475
+ };
2476
+ "list-project-top-items": {
2477
+ parameters: {
2478
+ query: {
2479
+ kind: "CPU_UTILIZATION" | "MEMORY_UTILIZATION" | "ROOT_FILESYSTEM_USED";
2480
+ /** @description 0 uses the default */
2481
+ limit?: number;
2482
+ };
2483
+ header?: never;
2484
+ path?: never;
2485
+ cookie?: never;
2486
+ };
2487
+ requestBody?: never;
2488
+ responses: {
2489
+ /** @description OK */
2490
+ 200: {
2491
+ headers: {
2492
+ [name: string]: unknown;
2493
+ };
2494
+ content: {
2495
+ "application/json": components["schemas"]["TopItemListResponseBody"];
2496
+ };
2497
+ };
2498
+ /** @description Error */
2499
+ default: {
2500
+ headers: {
2501
+ [name: string]: unknown;
2502
+ };
2503
+ content: {
2504
+ "application/json": components["schemas"]["Error"];
2505
+ };
2506
+ };
2507
+ };
2508
+ };
2509
+ "list-servers": {
2510
+ parameters: {
2511
+ query?: {
2512
+ /** @description Maximum number of records in this page */
2513
+ limit?: number;
2514
+ /** @description Number of records to skip. For deeper paging, use the cursor-paged endpoint instead */
2515
+ offset?: number;
2516
+ /** @description Fuzzy match on name or address */
2517
+ keyword?: string;
2518
+ monitoring_status?: "PENDING" | "ACTIVE" | "DISABLED" | "FAILED";
2519
+ };
2520
+ header?: never;
2521
+ path?: never;
2522
+ cookie?: never;
2523
+ };
2524
+ requestBody?: never;
2525
+ responses: {
2526
+ /** @description OK */
2527
+ 200: {
2528
+ headers: {
2529
+ [name: string]: unknown;
2530
+ };
2531
+ content: {
2532
+ "application/json": components["schemas"]["LengthAwarePageServerResource"];
2533
+ };
2534
+ };
2535
+ /** @description Error */
2536
+ default: {
2537
+ headers: {
2538
+ [name: string]: unknown;
2539
+ };
2540
+ content: {
2541
+ "application/json": components["schemas"]["Error"];
2542
+ };
2543
+ };
2544
+ };
2545
+ };
2546
+ "get-server": {
2547
+ parameters: {
2548
+ query?: never;
2549
+ header?: never;
2550
+ path: {
2551
+ serverId: string;
2552
+ };
2553
+ cookie?: never;
2554
+ };
2555
+ requestBody?: never;
2556
+ responses: {
2557
+ /** @description OK */
2558
+ 200: {
2559
+ headers: {
2560
+ [name: string]: unknown;
2561
+ };
2562
+ content: {
2563
+ "application/json": components["schemas"]["ServerResource"];
2564
+ };
2565
+ };
2566
+ /** @description Error */
2567
+ default: {
2568
+ headers: {
2569
+ [name: string]: unknown;
2570
+ };
2571
+ content: {
2572
+ "application/json": components["schemas"]["Error"];
2573
+ };
2574
+ };
2575
+ };
2576
+ };
2577
+ "enable-server-monitoring": {
2578
+ parameters: {
2579
+ query?: never;
2580
+ header?: never;
2581
+ path: {
2582
+ serverId: string;
2583
+ };
2584
+ cookie?: never;
2585
+ };
2586
+ requestBody: {
2587
+ content: {
2588
+ "application/json": components["schemas"]["EnableMonitoringRequestBody"];
2589
+ };
2590
+ };
2591
+ responses: {
2592
+ /** @description OK */
2593
+ 200: {
2594
+ headers: {
2595
+ [name: string]: unknown;
2596
+ };
2597
+ content: {
2598
+ "application/json": components["schemas"]["ServerEnrollmentResponseBody"];
2599
+ };
2600
+ };
2601
+ /** @description Error */
2602
+ default: {
2603
+ headers: {
2604
+ [name: string]: unknown;
2605
+ };
2606
+ content: {
2607
+ "application/json": components["schemas"]["Error"];
2608
+ };
2609
+ };
2610
+ };
2611
+ };
2612
+ "delete-server": {
2613
+ parameters: {
2614
+ query?: never;
2615
+ header?: never;
2616
+ path: {
2617
+ serverId: string;
2618
+ };
2619
+ cookie?: never;
2620
+ };
2621
+ requestBody?: never;
2622
+ responses: {
2623
+ /** @description No Content */
2624
+ 204: {
2625
+ headers: {
2626
+ [name: string]: unknown;
2627
+ };
2628
+ content?: never;
2629
+ };
2630
+ /** @description Error */
2631
+ default: {
2632
+ headers: {
2633
+ [name: string]: unknown;
2634
+ };
2635
+ content: {
2636
+ "application/json": components["schemas"]["Error"];
2637
+ };
2638
+ };
2639
+ };
2640
+ };
2641
+ "update-server": {
2642
+ parameters: {
2643
+ query?: never;
2644
+ header?: never;
2645
+ path: {
2646
+ serverId: string;
2647
+ };
2648
+ cookie?: never;
2649
+ };
2650
+ requestBody: {
2651
+ content: {
2652
+ "application/json": components["schemas"]["UpdateServerRequestBody"];
2653
+ };
2654
+ };
2655
+ responses: {
2656
+ /** @description OK */
2657
+ 200: {
2658
+ headers: {
2659
+ [name: string]: unknown;
2660
+ };
2661
+ content: {
2662
+ "application/json": components["schemas"]["ServerResource"];
2663
+ };
2664
+ };
2665
+ /** @description Error */
2666
+ default: {
2667
+ headers: {
2668
+ [name: string]: unknown;
2669
+ };
2670
+ content: {
2671
+ "application/json": components["schemas"]["Error"];
2672
+ };
2673
+ };
2674
+ };
2675
+ };
2676
+ "disable-server-monitoring": {
2677
+ parameters: {
2678
+ query?: never;
2679
+ header?: never;
2680
+ path: {
2681
+ serverId: string;
2682
+ };
2683
+ cookie?: never;
2684
+ };
2685
+ requestBody?: never;
2686
+ responses: {
2687
+ /** @description No Content */
2688
+ 204: {
2689
+ headers: {
2690
+ [name: string]: unknown;
2691
+ };
2692
+ content?: never;
2693
+ };
2694
+ /** @description Error */
2695
+ default: {
2696
+ headers: {
2697
+ [name: string]: unknown;
2698
+ };
2699
+ content: {
2700
+ "application/json": components["schemas"]["Error"];
2701
+ };
2702
+ };
2703
+ };
2704
+ };
2705
+ "rotate-agent-psk": {
2706
+ parameters: {
2707
+ query?: never;
2708
+ header?: never;
2709
+ path: {
2710
+ serverId: string;
2711
+ };
2712
+ cookie?: never;
2713
+ };
2714
+ requestBody?: never;
2715
+ responses: {
2716
+ /** @description OK */
2717
+ 200: {
2718
+ headers: {
2719
+ [name: string]: unknown;
2720
+ };
2721
+ content: {
2722
+ "application/json": components["schemas"]["EnrollmentResource"];
2723
+ };
2724
+ };
2725
+ /** @description Error */
2726
+ default: {
2727
+ headers: {
2728
+ [name: string]: unknown;
2729
+ };
2730
+ content: {
2731
+ "application/json": components["schemas"]["Error"];
2732
+ };
2733
+ };
2734
+ };
2735
+ };
2736
+ "get-web-check": {
2737
+ parameters: {
2738
+ query?: never;
2739
+ header?: never;
2740
+ path: {
2741
+ serverId: string;
2742
+ checkId: string;
2743
+ };
2744
+ cookie?: never;
2745
+ };
2746
+ requestBody?: never;
2747
+ responses: {
2748
+ /** @description OK */
2749
+ 200: {
2750
+ headers: {
2751
+ [name: string]: unknown;
2752
+ };
2753
+ content: {
2754
+ "application/json": components["schemas"]["WebCheckResource"];
2755
+ };
2756
+ };
2757
+ /** @description Error */
2758
+ default: {
2759
+ headers: {
2760
+ [name: string]: unknown;
2761
+ };
2762
+ content: {
2763
+ "application/json": components["schemas"]["Error"];
2764
+ };
2765
+ };
2766
+ };
2767
+ };
2768
+ "put-web-check": {
2769
+ parameters: {
2770
+ query?: never;
2771
+ header?: never;
2772
+ path: {
2773
+ serverId: string;
2774
+ checkId: string;
2775
+ };
2776
+ cookie?: never;
2777
+ };
2778
+ requestBody: {
2779
+ content: {
2780
+ "application/json": components["schemas"]["PutWebCheckRequestBody"];
2781
+ };
2782
+ };
2783
+ responses: {
2784
+ /** @description OK */
2785
+ 200: {
2786
+ headers: {
2787
+ [name: string]: unknown;
2788
+ };
2789
+ content: {
2790
+ "application/json": components["schemas"]["WebCheckResource"];
2791
+ };
2792
+ };
2793
+ /** @description Error */
2794
+ default: {
2795
+ headers: {
2796
+ [name: string]: unknown;
2797
+ };
2798
+ content: {
2799
+ "application/json": components["schemas"]["Error"];
2800
+ };
2801
+ };
2802
+ };
2803
+ };
2804
+ "delete-web-check": {
2805
+ parameters: {
2806
+ query?: never;
2807
+ header?: never;
2808
+ path: {
2809
+ serverId: string;
2810
+ checkId: string;
2811
+ };
2812
+ cookie?: never;
2813
+ };
2814
+ requestBody?: never;
2815
+ responses: {
2816
+ /** @description No Content */
2817
+ 204: {
2818
+ headers: {
2819
+ [name: string]: unknown;
2820
+ };
2821
+ content?: never;
2822
+ };
2823
+ /** @description Error */
2824
+ default: {
2825
+ headers: {
2826
+ [name: string]: unknown;
2827
+ };
2828
+ content: {
2829
+ "application/json": components["schemas"]["Error"];
2830
+ };
2831
+ };
2832
+ };
2833
+ };
2834
+ "list-web-checks": {
2835
+ parameters: {
2836
+ query?: {
2837
+ /** @description Restrict to the checks of a single machine. Omit for the whole project */
2838
+ server_id?: string;
2839
+ };
2840
+ header?: never;
2841
+ path?: never;
2842
+ cookie?: never;
2843
+ };
2844
+ requestBody?: never;
2845
+ responses: {
2846
+ /** @description OK */
2847
+ 200: {
2848
+ headers: {
2849
+ [name: string]: unknown;
2850
+ };
2851
+ content: {
2852
+ "application/json": components["schemas"]["WebCheckListResponseBody"];
2853
+ };
2854
+ };
2855
+ /** @description Error */
2856
+ default: {
2857
+ headers: {
2858
+ [name: string]: unknown;
2859
+ };
2860
+ content: {
2861
+ "application/json": components["schemas"]["Error"];
2862
+ };
2863
+ };
2864
+ };
2865
+ };
2866
+ "get-sli-report": {
2867
+ parameters: {
2868
+ query?: {
2869
+ from?: string;
2870
+ to?: string;
2871
+ /** @description Return the most recent N complete periods. Use this or from/to, not both */
2872
+ periods?: number;
2873
+ };
2874
+ header?: never;
2875
+ path?: never;
2876
+ cookie?: never;
2877
+ };
2878
+ requestBody?: never;
2879
+ responses: {
2880
+ /** @description OK */
2881
+ 200: {
2882
+ headers: {
2883
+ [name: string]: unknown;
2884
+ };
2885
+ content: {
2886
+ "application/json": components["schemas"]["SLIReportResponseBody"];
2887
+ };
2888
+ };
2889
+ /** @description Error */
2890
+ default: {
2891
+ headers: {
2892
+ [name: string]: unknown;
2893
+ };
2894
+ content: {
2895
+ "application/json": components["schemas"]["Error"];
2896
+ };
2897
+ };
2898
+ };
2899
+ };
2900
+ "get-slo": {
2901
+ parameters: {
2902
+ query?: never;
2903
+ header?: never;
2904
+ path?: never;
2905
+ cookie?: never;
2906
+ };
2907
+ requestBody?: never;
2908
+ responses: {
2909
+ /** @description OK */
2910
+ 200: {
2911
+ headers: {
2912
+ [name: string]: unknown;
2913
+ };
2914
+ content: {
2915
+ "application/json": components["schemas"]["SLOResource"];
2916
+ };
2917
+ };
2918
+ /** @description Error */
2919
+ default: {
2920
+ headers: {
2921
+ [name: string]: unknown;
2922
+ };
2923
+ content: {
2924
+ "application/json": components["schemas"]["Error"];
2925
+ };
2926
+ };
2927
+ };
2928
+ };
2929
+ "put-slo": {
2930
+ parameters: {
2931
+ query?: never;
2932
+ header?: never;
2933
+ path?: never;
2934
+ cookie?: never;
2935
+ };
2936
+ requestBody: {
2937
+ content: {
2938
+ "application/json": components["schemas"]["PutSLORequestBody"];
2939
+ };
2940
+ };
2941
+ responses: {
2942
+ /** @description OK */
2943
+ 200: {
2944
+ headers: {
2945
+ [name: string]: unknown;
2946
+ };
2947
+ content: {
2948
+ "application/json": components["schemas"]["SLOResource"];
2949
+ };
2950
+ };
2951
+ /** @description Error */
2952
+ default: {
2953
+ headers: {
2954
+ [name: string]: unknown;
2955
+ };
2956
+ content: {
2957
+ "application/json": components["schemas"]["Error"];
2958
+ };
2959
+ };
2960
+ };
2961
+ };
2962
+ "delete-slo": {
2963
+ parameters: {
2964
+ query?: never;
2965
+ header?: never;
2966
+ path?: never;
2967
+ cookie?: never;
2968
+ };
2969
+ requestBody?: never;
2970
+ responses: {
2971
+ /** @description No Content */
2972
+ 204: {
2973
+ headers: {
2974
+ [name: string]: unknown;
2975
+ };
2976
+ content?: never;
2977
+ };
2978
+ /** @description Error */
2979
+ default: {
2980
+ headers: {
2981
+ [name: string]: unknown;
2982
+ };
2983
+ content: {
2984
+ "application/json": components["schemas"]["Error"];
2985
+ };
2986
+ };
2987
+ };
2988
+ };
2989
+ "get-status-page": {
2990
+ parameters: {
2991
+ query?: never;
2992
+ header?: never;
2993
+ path?: never;
2994
+ cookie?: never;
2995
+ };
2996
+ requestBody?: never;
2997
+ responses: {
2998
+ /** @description OK */
2999
+ 200: {
3000
+ headers: {
3001
+ [name: string]: unknown;
3002
+ };
3003
+ content: {
3004
+ "application/json": components["schemas"]["StatusPageResource"];
3005
+ };
3006
+ };
3007
+ /** @description Error */
3008
+ default: {
3009
+ headers: {
3010
+ [name: string]: unknown;
3011
+ };
3012
+ content: {
3013
+ "application/json": components["schemas"]["Error"];
3014
+ };
3015
+ };
3016
+ };
3017
+ };
3018
+ "put-status-page": {
1516
3019
  parameters: {
1517
3020
  query?: never;
1518
3021
  header?: never;
1519
- path: {
1520
- windowId: string;
1521
- };
3022
+ path?: never;
1522
3023
  cookie?: never;
1523
3024
  };
1524
- requestBody?: never;
3025
+ requestBody: {
3026
+ content: {
3027
+ "application/json": components["schemas"]["PutStatusPageRequestBody"];
3028
+ };
3029
+ };
1525
3030
  responses: {
1526
3031
  /** @description OK */
1527
3032
  200: {
@@ -1529,7 +3034,7 @@ export interface operations {
1529
3034
  [name: string]: unknown;
1530
3035
  };
1531
3036
  content: {
1532
- "application/json": components["schemas"]["MaintenanceWindowResource"];
3037
+ "application/json": components["schemas"]["StatusPageResource"];
1533
3038
  };
1534
3039
  };
1535
3040
  /** @description Error */
@@ -1543,29 +3048,21 @@ export interface operations {
1543
3048
  };
1544
3049
  };
1545
3050
  };
1546
- "put-maintenance-window": {
3051
+ "delete-status-page": {
1547
3052
  parameters: {
1548
3053
  query?: never;
1549
3054
  header?: never;
1550
- path: {
1551
- windowId: string;
1552
- };
3055
+ path?: never;
1553
3056
  cookie?: never;
1554
3057
  };
1555
- requestBody: {
1556
- content: {
1557
- "application/json": components["schemas"]["PutMaintenanceWindowRequestBody"];
1558
- };
1559
- };
3058
+ requestBody?: never;
1560
3059
  responses: {
1561
- /** @description OK */
1562
- 200: {
3060
+ /** @description No Content */
3061
+ 204: {
1563
3062
  headers: {
1564
3063
  [name: string]: unknown;
1565
3064
  };
1566
- content: {
1567
- "application/json": components["schemas"]["MaintenanceWindowResource"];
1568
- };
3065
+ content?: never;
1569
3066
  };
1570
3067
  /** @description Error */
1571
3068
  default: {
@@ -1578,16 +3075,18 @@ export interface operations {
1578
3075
  };
1579
3076
  };
1580
3077
  };
1581
- "delete-maintenance-window": {
3078
+ "put-status-page-order": {
1582
3079
  parameters: {
1583
3080
  query?: never;
1584
3081
  header?: never;
1585
- path: {
1586
- windowId: string;
1587
- };
3082
+ path?: never;
1588
3083
  cookie?: never;
1589
3084
  };
1590
- requestBody?: never;
3085
+ requestBody: {
3086
+ content: {
3087
+ "application/json": components["schemas"]["PutStatusPageOrderRequestBody"];
3088
+ };
3089
+ };
1591
3090
  responses: {
1592
3091
  /** @description No Content */
1593
3092
  204: {
@@ -1607,7 +3106,7 @@ export interface operations {
1607
3106
  };
1608
3107
  };
1609
3108
  };
1610
- "get-project-overview": {
3109
+ "list-status-page-groups": {
1611
3110
  parameters: {
1612
3111
  query?: never;
1613
3112
  header?: never;
@@ -1622,7 +3121,7 @@ export interface operations {
1622
3121
  [name: string]: unknown;
1623
3122
  };
1624
3123
  content: {
1625
- "application/json": components["schemas"]["ProjectOverviewResource"];
3124
+ "application/json": components["schemas"]["StatusPageGroupListResponseBody"];
1626
3125
  };
1627
3126
  };
1628
3127
  /** @description Error */
@@ -1636,29 +3135,26 @@ export interface operations {
1636
3135
  };
1637
3136
  };
1638
3137
  };
1639
- "list-server-items": {
3138
+ "create-status-page-group": {
1640
3139
  parameters: {
1641
- query?: {
1642
- /** @description 按 key 或名字模糊匹配 */
1643
- keyword?: string;
1644
- /** @description 形如 key 或 key=value,可重复。官方模板打好的 component 标签(cpu / memory / filesystem…)就是靠它筛 */
1645
- tag?: string[] | null;
1646
- };
3140
+ query?: never;
1647
3141
  header?: never;
1648
- path: {
1649
- serverId: string;
1650
- };
3142
+ path?: never;
1651
3143
  cookie?: never;
1652
3144
  };
1653
- requestBody?: never;
3145
+ requestBody: {
3146
+ content: {
3147
+ "application/json": components["schemas"]["PutStatusPageGroupRequestBody"];
3148
+ };
3149
+ };
1654
3150
  responses: {
1655
- /** @description OK */
1656
- 200: {
3151
+ /** @description Created */
3152
+ 201: {
1657
3153
  headers: {
1658
3154
  [name: string]: unknown;
1659
3155
  };
1660
3156
  content: {
1661
- "application/json": components["schemas"]["ItemListResponseBody"];
3157
+ "application/json": components["schemas"]["StatusPageGroupResource"];
1662
3158
  };
1663
3159
  };
1664
3160
  /** @description Error */
@@ -1672,27 +3168,20 @@ export interface operations {
1672
3168
  };
1673
3169
  };
1674
3170
  };
1675
- "get-server-metric": {
3171
+ "update-status-page-group": {
1676
3172
  parameters: {
1677
- query?: {
1678
- /** @description **前缀匹配**:vfs.fs.size 一次拿回每个挂载点一条线。与 item_id 至少给一个 */
1679
- item_key?: string;
1680
- item_id?: string;
1681
- /** @description 不给就是一小时前 */
1682
- from?: string;
1683
- to?: string;
1684
- /** @description 降采样的桶数,0 表示原样返回采集到的数据点 */
1685
- max_points?: number;
1686
- /** @description 顺带取这些监控项当前生效的阈值线 */
1687
- include_thresholds?: boolean;
1688
- };
3173
+ query?: never;
1689
3174
  header?: never;
1690
3175
  path: {
1691
- serverId: string;
3176
+ groupId: string;
1692
3177
  };
1693
3178
  cookie?: never;
1694
3179
  };
1695
- requestBody?: never;
3180
+ requestBody: {
3181
+ content: {
3182
+ "application/json": components["schemas"]["PutStatusPageGroupRequestBody"];
3183
+ };
3184
+ };
1696
3185
  responses: {
1697
3186
  /** @description OK */
1698
3187
  200: {
@@ -1700,7 +3189,7 @@ export interface operations {
1700
3189
  [name: string]: unknown;
1701
3190
  };
1702
3191
  content: {
1703
- "application/json": components["schemas"]["MetricResponseBody"];
3192
+ "application/json": components["schemas"]["StatusPageGroupResource"];
1704
3193
  };
1705
3194
  };
1706
3195
  /** @description Error */
@@ -1714,25 +3203,23 @@ export interface operations {
1714
3203
  };
1715
3204
  };
1716
3205
  };
1717
- "get-server-resources": {
3206
+ "delete-status-page-group": {
1718
3207
  parameters: {
1719
3208
  query?: never;
1720
3209
  header?: never;
1721
3210
  path: {
1722
- serverId: string;
3211
+ groupId: string;
1723
3212
  };
1724
3213
  cookie?: never;
1725
3214
  };
1726
3215
  requestBody?: never;
1727
3216
  responses: {
1728
- /** @description OK */
1729
- 200: {
3217
+ /** @description No Content */
3218
+ 204: {
1730
3219
  headers: {
1731
3220
  [name: string]: unknown;
1732
3221
  };
1733
- content: {
1734
- "application/json": components["schemas"]["ServerResourcesResource"];
1735
- };
3222
+ content?: never;
1736
3223
  };
1737
3224
  /** @description Error */
1738
3225
  default: {
@@ -1745,25 +3232,27 @@ export interface operations {
1745
3232
  };
1746
3233
  };
1747
3234
  };
1748
- "get-server-snapshot": {
3235
+ "put-status-page-group-order": {
1749
3236
  parameters: {
1750
3237
  query?: never;
1751
3238
  header?: never;
1752
3239
  path: {
1753
- serverId: string;
3240
+ groupId: string;
1754
3241
  };
1755
3242
  cookie?: never;
1756
3243
  };
1757
- requestBody?: never;
3244
+ requestBody: {
3245
+ content: {
3246
+ "application/json": components["schemas"]["PutStatusPageGroupOrderRequestBody"];
3247
+ };
3248
+ };
1758
3249
  responses: {
1759
- /** @description OK */
1760
- 200: {
3250
+ /** @description No Content */
3251
+ 204: {
1761
3252
  headers: {
1762
3253
  [name: string]: unknown;
1763
3254
  };
1764
- content: {
1765
- "application/json": components["schemas"]["SnapshotResource"];
1766
- };
3255
+ content?: never;
1767
3256
  };
1768
3257
  /** @description Error */
1769
3258
  default: {
@@ -1776,13 +3265,9 @@ export interface operations {
1776
3265
  };
1777
3266
  };
1778
3267
  };
1779
- "list-project-top-items": {
3268
+ "list-status-page-components": {
1780
3269
  parameters: {
1781
- query: {
1782
- kind: "CPU_UTILIZATION" | "MEMORY_UTILIZATION" | "ROOT_FILESYSTEM_USED";
1783
- /** @description 0 表示用默认 */
1784
- limit?: number;
1785
- };
3270
+ query?: never;
1786
3271
  header?: never;
1787
3272
  path?: never;
1788
3273
  cookie?: never;
@@ -1795,7 +3280,7 @@ export interface operations {
1795
3280
  [name: string]: unknown;
1796
3281
  };
1797
3282
  content: {
1798
- "application/json": components["schemas"]["TopItemListResponseBody"];
3283
+ "application/json": components["schemas"]["StatusPageComponentListResponseBody"];
1799
3284
  };
1800
3285
  };
1801
3286
  /** @description Error */
@@ -1809,30 +3294,26 @@ export interface operations {
1809
3294
  };
1810
3295
  };
1811
3296
  };
1812
- "list-servers": {
3297
+ "create-status-page-component": {
1813
3298
  parameters: {
1814
- query?: {
1815
- /** @description 这一页最多返回多少条 */
1816
- limit?: number;
1817
- /** @description 跳过多少条。要翻得更深请改用游标翻页的接口 */
1818
- offset?: number;
1819
- /** @description 按名字或地址模糊匹配 */
1820
- keyword?: string;
1821
- monitoring_status?: "PENDING" | "ACTIVE" | "DISABLED" | "FAILED";
1822
- };
3299
+ query?: never;
1823
3300
  header?: never;
1824
3301
  path?: never;
1825
3302
  cookie?: never;
1826
3303
  };
1827
- requestBody?: never;
3304
+ requestBody: {
3305
+ content: {
3306
+ "application/json": components["schemas"]["PutStatusPageComponentRequestBody"];
3307
+ };
3308
+ };
1828
3309
  responses: {
1829
- /** @description OK */
1830
- 200: {
3310
+ /** @description Created */
3311
+ 201: {
1831
3312
  headers: {
1832
3313
  [name: string]: unknown;
1833
3314
  };
1834
3315
  content: {
1835
- "application/json": components["schemas"]["LengthAwarePageServerResource"];
3316
+ "application/json": components["schemas"]["StatusPageComponentResource"];
1836
3317
  };
1837
3318
  };
1838
3319
  /** @description Error */
@@ -1846,12 +3327,12 @@ export interface operations {
1846
3327
  };
1847
3328
  };
1848
3329
  };
1849
- "get-server": {
3330
+ "get-status-page-component": {
1850
3331
  parameters: {
1851
3332
  query?: never;
1852
3333
  header?: never;
1853
3334
  path: {
1854
- serverId: string;
3335
+ componentId: string;
1855
3336
  };
1856
3337
  cookie?: never;
1857
3338
  };
@@ -1863,7 +3344,7 @@ export interface operations {
1863
3344
  [name: string]: unknown;
1864
3345
  };
1865
3346
  content: {
1866
- "application/json": components["schemas"]["ServerResource"];
3347
+ "application/json": components["schemas"]["StatusPageComponentResource"];
1867
3348
  };
1868
3349
  };
1869
3350
  /** @description Error */
@@ -1877,18 +3358,18 @@ export interface operations {
1877
3358
  };
1878
3359
  };
1879
3360
  };
1880
- "enable-server-monitoring": {
3361
+ "update-status-page-component": {
1881
3362
  parameters: {
1882
3363
  query?: never;
1883
3364
  header?: never;
1884
3365
  path: {
1885
- serverId: string;
3366
+ componentId: string;
1886
3367
  };
1887
3368
  cookie?: never;
1888
3369
  };
1889
3370
  requestBody: {
1890
3371
  content: {
1891
- "application/json": components["schemas"]["EnableMonitoringRequestBody"];
3372
+ "application/json": components["schemas"]["PutStatusPageComponentRequestBody"];
1892
3373
  };
1893
3374
  };
1894
3375
  responses: {
@@ -1898,7 +3379,7 @@ export interface operations {
1898
3379
  [name: string]: unknown;
1899
3380
  };
1900
3381
  content: {
1901
- "application/json": components["schemas"]["ServerEnrollmentResponseBody"];
3382
+ "application/json": components["schemas"]["StatusPageComponentResource"];
1902
3383
  };
1903
3384
  };
1904
3385
  /** @description Error */
@@ -1912,12 +3393,12 @@ export interface operations {
1912
3393
  };
1913
3394
  };
1914
3395
  };
1915
- "delete-server": {
3396
+ "delete-status-page-component": {
1916
3397
  parameters: {
1917
3398
  query?: never;
1918
3399
  header?: never;
1919
3400
  path: {
1920
- serverId: string;
3401
+ componentId: string;
1921
3402
  };
1922
3403
  cookie?: never;
1923
3404
  };
@@ -1941,20 +3422,16 @@ export interface operations {
1941
3422
  };
1942
3423
  };
1943
3424
  };
1944
- "update-server": {
3425
+ "list-status-page-component-sources": {
1945
3426
  parameters: {
1946
3427
  query?: never;
1947
3428
  header?: never;
1948
3429
  path: {
1949
- serverId: string;
3430
+ componentId: string;
1950
3431
  };
1951
3432
  cookie?: never;
1952
3433
  };
1953
- requestBody: {
1954
- content: {
1955
- "application/json": components["schemas"]["UpdateServerRequestBody"];
1956
- };
1957
- };
3434
+ requestBody?: never;
1958
3435
  responses: {
1959
3436
  /** @description OK */
1960
3437
  200: {
@@ -1962,7 +3439,7 @@ export interface operations {
1962
3439
  [name: string]: unknown;
1963
3440
  };
1964
3441
  content: {
1965
- "application/json": components["schemas"]["ServerResource"];
3442
+ "application/json": components["schemas"]["StatusPageComponentSourcesResource"];
1966
3443
  };
1967
3444
  };
1968
3445
  /** @description Error */
@@ -1976,23 +3453,29 @@ export interface operations {
1976
3453
  };
1977
3454
  };
1978
3455
  };
1979
- "disable-server-monitoring": {
3456
+ "put-status-page-component-sources": {
1980
3457
  parameters: {
1981
3458
  query?: never;
1982
3459
  header?: never;
1983
3460
  path: {
1984
- serverId: string;
3461
+ componentId: string;
1985
3462
  };
1986
3463
  cookie?: never;
1987
3464
  };
1988
- requestBody?: never;
3465
+ requestBody: {
3466
+ content: {
3467
+ "application/json": components["schemas"]["PutStatusPageComponentSourcesRequestBody"];
3468
+ };
3469
+ };
1989
3470
  responses: {
1990
- /** @description No Content */
1991
- 204: {
3471
+ /** @description OK */
3472
+ 200: {
1992
3473
  headers: {
1993
3474
  [name: string]: unknown;
1994
3475
  };
1995
- content?: never;
3476
+ content: {
3477
+ "application/json": components["schemas"]["StatusPageComponentSourcesResource"];
3478
+ };
1996
3479
  };
1997
3480
  /** @description Error */
1998
3481
  default: {
@@ -2005,13 +3488,15 @@ export interface operations {
2005
3488
  };
2006
3489
  };
2007
3490
  };
2008
- "rotate-agent-psk": {
3491
+ "list-status-page-incidents": {
2009
3492
  parameters: {
2010
- query?: never;
2011
- header?: never;
2012
- path: {
2013
- serverId: string;
3493
+ query?: {
3494
+ /** @description Maximum number of records in this page */
3495
+ limit?: number;
3496
+ offset?: number;
2014
3497
  };
3498
+ header?: never;
3499
+ path?: never;
2015
3500
  cookie?: never;
2016
3501
  };
2017
3502
  requestBody?: never;
@@ -2022,7 +3507,7 @@ export interface operations {
2022
3507
  [name: string]: unknown;
2023
3508
  };
2024
3509
  content: {
2025
- "application/json": components["schemas"]["EnrollmentResource"];
3510
+ "application/json": components["schemas"]["LengthAwarePageStatusPageIncidentResource"];
2026
3511
  };
2027
3512
  };
2028
3513
  /** @description Error */
@@ -2036,25 +3521,26 @@ export interface operations {
2036
3521
  };
2037
3522
  };
2038
3523
  };
2039
- "get-web-check": {
3524
+ "publish-status-page-incident": {
2040
3525
  parameters: {
2041
3526
  query?: never;
2042
3527
  header?: never;
2043
- path: {
2044
- serverId: string;
2045
- checkId: string;
2046
- };
3528
+ path?: never;
2047
3529
  cookie?: never;
2048
3530
  };
2049
- requestBody?: never;
3531
+ requestBody: {
3532
+ content: {
3533
+ "application/json": components["schemas"]["PublishStatusPageIncidentRequestBody"];
3534
+ };
3535
+ };
2050
3536
  responses: {
2051
- /** @description OK */
2052
- 200: {
3537
+ /** @description Created */
3538
+ 201: {
2053
3539
  headers: {
2054
3540
  [name: string]: unknown;
2055
3541
  };
2056
3542
  content: {
2057
- "application/json": components["schemas"]["WebCheckResource"];
3543
+ "application/json": components["schemas"]["StatusPageIncidentResource"];
2058
3544
  };
2059
3545
  };
2060
3546
  /** @description Error */
@@ -2068,21 +3554,16 @@ export interface operations {
2068
3554
  };
2069
3555
  };
2070
3556
  };
2071
- "put-web-check": {
3557
+ "get-status-page-incident": {
2072
3558
  parameters: {
2073
3559
  query?: never;
2074
3560
  header?: never;
2075
3561
  path: {
2076
- serverId: string;
2077
- checkId: string;
3562
+ incidentId: string;
2078
3563
  };
2079
3564
  cookie?: never;
2080
3565
  };
2081
- requestBody: {
2082
- content: {
2083
- "application/json": components["schemas"]["PutWebCheckRequestBody"];
2084
- };
2085
- };
3566
+ requestBody?: never;
2086
3567
  responses: {
2087
3568
  /** @description OK */
2088
3569
  200: {
@@ -2090,7 +3571,7 @@ export interface operations {
2090
3571
  [name: string]: unknown;
2091
3572
  };
2092
3573
  content: {
2093
- "application/json": components["schemas"]["WebCheckResource"];
3574
+ "application/json": components["schemas"]["StatusPageIncidentResource"];
2094
3575
  };
2095
3576
  };
2096
3577
  /** @description Error */
@@ -2104,24 +3585,29 @@ export interface operations {
2104
3585
  };
2105
3586
  };
2106
3587
  };
2107
- "delete-web-check": {
3588
+ "post-status-page-incident-update": {
2108
3589
  parameters: {
2109
3590
  query?: never;
2110
3591
  header?: never;
2111
3592
  path: {
2112
- serverId: string;
2113
- checkId: string;
3593
+ incidentId: string;
2114
3594
  };
2115
3595
  cookie?: never;
2116
3596
  };
2117
- requestBody?: never;
3597
+ requestBody: {
3598
+ content: {
3599
+ "application/json": components["schemas"]["PostStatusPageIncidentUpdateRequestBody"];
3600
+ };
3601
+ };
2118
3602
  responses: {
2119
- /** @description No Content */
2120
- 204: {
3603
+ /** @description OK */
3604
+ 200: {
2121
3605
  headers: {
2122
3606
  [name: string]: unknown;
2123
3607
  };
2124
- content?: never;
3608
+ content: {
3609
+ "application/json": components["schemas"]["StatusPageIncidentResource"];
3610
+ };
2125
3611
  };
2126
3612
  /** @description Error */
2127
3613
  default: {
@@ -2134,11 +3620,12 @@ export interface operations {
2134
3620
  };
2135
3621
  };
2136
3622
  };
2137
- "list-web-checks": {
3623
+ "list-status-page-maintenances": {
2138
3624
  parameters: {
2139
3625
  query?: {
2140
- /** @description 只看某一台机器的检查;不给就是整个项目的 */
2141
- server_id?: string;
3626
+ /** @description Maximum number of records in this page */
3627
+ limit?: number;
3628
+ offset?: number;
2142
3629
  };
2143
3630
  header?: never;
2144
3631
  path?: never;
@@ -2152,7 +3639,7 @@ export interface operations {
2152
3639
  [name: string]: unknown;
2153
3640
  };
2154
3641
  content: {
2155
- "application/json": components["schemas"]["WebCheckListResponseBody"];
3642
+ "application/json": components["schemas"]["LengthAwarePageStatusPageMaintenanceResource"];
2156
3643
  };
2157
3644
  };
2158
3645
  /** @description Error */
@@ -2166,27 +3653,26 @@ export interface operations {
2166
3653
  };
2167
3654
  };
2168
3655
  };
2169
- "get-sli-report": {
3656
+ "schedule-status-page-maintenance": {
2170
3657
  parameters: {
2171
- query?: {
2172
- from?: string;
2173
- to?: string;
2174
- /** @description 取最近 N 个完整周期,与 from/to 二选一 */
2175
- periods?: number;
2176
- };
3658
+ query?: never;
2177
3659
  header?: never;
2178
3660
  path?: never;
2179
3661
  cookie?: never;
2180
3662
  };
2181
- requestBody?: never;
3663
+ requestBody: {
3664
+ content: {
3665
+ "application/json": components["schemas"]["ScheduleStatusPageMaintenanceRequestBody"];
3666
+ };
3667
+ };
2182
3668
  responses: {
2183
- /** @description OK */
2184
- 200: {
3669
+ /** @description Created */
3670
+ 201: {
2185
3671
  headers: {
2186
3672
  [name: string]: unknown;
2187
3673
  };
2188
3674
  content: {
2189
- "application/json": components["schemas"]["SLIReportResponseBody"];
3675
+ "application/json": components["schemas"]["StatusPageMaintenanceResource"];
2190
3676
  };
2191
3677
  };
2192
3678
  /** @description Error */
@@ -2200,11 +3686,13 @@ export interface operations {
2200
3686
  };
2201
3687
  };
2202
3688
  };
2203
- "get-slo": {
3689
+ "get-status-page-maintenance": {
2204
3690
  parameters: {
2205
3691
  query?: never;
2206
3692
  header?: never;
2207
- path?: never;
3693
+ path: {
3694
+ maintenanceId: string;
3695
+ };
2208
3696
  cookie?: never;
2209
3697
  };
2210
3698
  requestBody?: never;
@@ -2215,7 +3703,7 @@ export interface operations {
2215
3703
  [name: string]: unknown;
2216
3704
  };
2217
3705
  content: {
2218
- "application/json": components["schemas"]["SLOResource"];
3706
+ "application/json": components["schemas"]["StatusPageMaintenanceResource"];
2219
3707
  };
2220
3708
  };
2221
3709
  /** @description Error */
@@ -2229,18 +3717,16 @@ export interface operations {
2229
3717
  };
2230
3718
  };
2231
3719
  };
2232
- "put-slo": {
3720
+ "cancel-status-page-maintenance": {
2233
3721
  parameters: {
2234
3722
  query?: never;
2235
3723
  header?: never;
2236
- path?: never;
2237
- cookie?: never;
2238
- };
2239
- requestBody: {
2240
- content: {
2241
- "application/json": components["schemas"]["PutSLORequestBody"];
3724
+ path: {
3725
+ maintenanceId: string;
2242
3726
  };
3727
+ cookie?: never;
2243
3728
  };
3729
+ requestBody?: never;
2244
3730
  responses: {
2245
3731
  /** @description OK */
2246
3732
  200: {
@@ -2248,7 +3734,7 @@ export interface operations {
2248
3734
  [name: string]: unknown;
2249
3735
  };
2250
3736
  content: {
2251
- "application/json": components["schemas"]["SLOResource"];
3737
+ "application/json": components["schemas"]["StatusPageMaintenanceResource"];
2252
3738
  };
2253
3739
  };
2254
3740
  /** @description Error */
@@ -2262,21 +3748,25 @@ export interface operations {
2262
3748
  };
2263
3749
  };
2264
3750
  };
2265
- "delete-slo": {
3751
+ "complete-status-page-maintenance": {
2266
3752
  parameters: {
2267
3753
  query?: never;
2268
3754
  header?: never;
2269
- path?: never;
3755
+ path: {
3756
+ maintenanceId: string;
3757
+ };
2270
3758
  cookie?: never;
2271
3759
  };
2272
3760
  requestBody?: never;
2273
3761
  responses: {
2274
- /** @description No Content */
2275
- 204: {
3762
+ /** @description OK */
3763
+ 200: {
2276
3764
  headers: {
2277
3765
  [name: string]: unknown;
2278
3766
  };
2279
- content?: never;
3767
+ content: {
3768
+ "application/json": components["schemas"]["StatusPageMaintenanceResource"];
3769
+ };
2280
3770
  };
2281
3771
  /** @description Error */
2282
3772
  default: {