@leaflow/sdk 0.2.0 → 0.3.0

package/openapi/monitoring.yaml

@@ -61,6 +61,21 @@ components:
         - key
         - count
       type: object
+    CursorPageIncidentActivityResource:
+      additionalProperties: false
+      properties:
+        items:
+          description: 这一页的内容
+          items:
+            $ref: "#/components/schemas/IncidentActivityResource"
+          type: array
+        next_cursor:
+          description: 下一页的游标；为空表示已经到底
+          type: string
+      required:
+        - items
+        - next_cursor
+      type: object
     EnableMonitoringRequestBody:
       additionalProperties: false
       properties:
@@ -166,21 +181,6 @@ components:
         - use_ip
         - available
       type: object
-    IncidentActivityListResponseBody:
-      additionalProperties: false
-      properties:
-        items:
-          items:
-            $ref: "#/components/schemas/IncidentActivityResource"
-          type:
-            - array
-            - "null"
-        next_cursor:
-          type: string
-      required:
-        - items
-        - next_cursor
-      type: object
     IncidentActivityResource:
       additionalProperties: false
       properties:
@@ -254,22 +254,6 @@ components:
         - display_name
         - followed_at
       type: object
-    IncidentListResponseBody:
-      additionalProperties: false
-      properties:
-        items:
-          items:
-            $ref: "#/components/schemas/IncidentResource"
-          type:
-            - array
-            - "null"
-        total:
-          format: int64
-          type: integer
-      required:
-        - items
-        - total
-      type: object
     IncidentResource:
       additionalProperties: false
       properties:
@@ -495,6 +479,58 @@ components:
         - aggregation_function
         - evaluation_window_seconds
       type: object
+    LengthAwarePageIncidentResource:
+      additionalProperties: false
+      properties:
+        items:
+          description: 这一页的内容
+          items:
+            $ref: "#/components/schemas/IncidentResource"
+          type: array
+        limit:
+          description: 这一页最多几条，回显请求里的值
+          format: int64
+          type: integer
+        offset:
+          description: 跳过了多少条，回显请求里的值
+          format: int64
+          type: integer
+        total:
+          description: 命中的总条数，不只是这一页
+          format: int64
+          type: integer
+      required:
+        - items
+        - total
+        - limit
+        - offset
+      type: object
+    LengthAwarePageServerResource:
+      additionalProperties: false
+      properties:
+        items:
+          description: 这一页的内容
+          items:
+            $ref: "#/components/schemas/ServerResource"
+          type: array
+        limit:
+          description: 这一页最多几条，回显请求里的值
+          format: int64
+          type: integer
+        offset:
+          description: 跳过了多少条，回显请求里的值
+          format: int64
+          type: integer
+        total:
+          description: 命中的总条数，不只是这一页
+          format: int64
+          type: integer
+      required:
+        - items
+        - total
+        - limit
+        - offset
+      type: object
     MaintenancePeriodRequest:
       additionalProperties: false
       properties:
@@ -1068,22 +1104,6 @@ components:
         - server
         - enrollment
       type: object
-    ServerListResponseBody:
-      additionalProperties: false
-      properties:
-        items:
-          items:
-            $ref: "#/components/schemas/ServerResource"
-          type:
-            - array
-            - "null"
-        total:
-          format: int64
-          type: integer
-      required:
-        - items
-        - total
-      type: object
     ServerResource:
       additionalProperties: false
       properties:
@@ -1480,6 +1500,12 @@ components:
         - required_pattern
         - follow_redirects
       type: object
+  securitySchemes:
+    bearerAuth:
+      bearerFormat: JWT
+      description: 项目令牌。先在 auth.leaflow.net 登录拿到账号令牌，再用它向 IAM 换取项目令牌（POST /api/v1/projects/{projectId}/token）——一张项目令牌同时说明当前用户和当前项目。
+      scheme: bearer
+      type: http
 info:
   description: |-
     用户自己项目里的监控：接入机器、看指标、处理告警、开维护窗口、定可用率目标。
@@ -1509,31 +1535,25 @@ paths:
       description: "`incident_status` 表示监控系统是否判定已恢复，`closed` 表示是否有人完成了处理。两者相互独立，可分别筛选。"
       operationId: list-incidents
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
+        - description: 这一页最多返回多少条
           explode: false
           in: query
           name: limit
           schema:
             default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
+            description: 这一页最多返回多少条
             format: int64
-            maximum: 500
-            minimum: 0
+            maximum: 200
+            minimum: 1
             type: integer
-        - description: 跳过多少条
+        - description: 跳过多少条。要翻得更深请改用游标翻页的接口
           explode: false
           in: query
           name: offset
           schema:
-            description: 跳过多少条
+            description: 跳过多少条。要翻得更深请改用游标翻页的接口
             format: int64
+            maximum: 10000
             minimum: 0
             type: integer
         - description: 只看某一台机器的
@@ -1644,7 +1664,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/IncidentListResponseBody"
+                $ref: "#/components/schemas/LengthAwarePageIncidentResource"
           description: OK
         default:
           content:
@@ -1659,13 +1679,6 @@ paths:
     get:
       operationId: get-incident
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1693,13 +1706,6 @@ paths:
       description: 同时会在监控系统中标记为已确认，便于其他渠道也能看到该告警已有人处理。
       operationId: acknowledge-incident
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1736,13 +1742,6 @@ paths:
         **这里不校验被指派的人在不在这个项目里**——那要问 IAM，而这个服务的准入还没接。
       operationId: assign-incident
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1776,13 +1775,6 @@ paths:
       description: 了结的是**平台上的处理流程**，不是告警本身的状态：尚未恢复的告警也可以按「已接受的风险」了结，它在监控系统中仍为未恢复。
       operationId: close-incident
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1815,13 +1807,6 @@ paths:
     post:
       operationId: add-incident-comment
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1855,13 +1840,6 @@ paths:
       description: 关注的是**自己**：操作者就是被加进关注列表的那个人。
       operationId: set-incident-following
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1894,13 +1872,6 @@ paths:
     post:
       operationId: reopen-incident
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1928,13 +1899,6 @@ paths:
       description: 游标翻页而不是偏移量：时间线是只增的，用偏移量翻页会在新记录写入时漏行和重行。
       operationId: list-incident-timeline
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: incidentId
           required: true
@@ -1962,7 +1926,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/IncidentActivityListResponseBody"
+                $ref: "#/components/schemas/CursorPageIncidentActivityResource"
           description: OK
         default:
           content:
@@ -1976,14 +1940,6 @@ paths:
   /api/v1/maintenance-windows:
     get:
       operationId: list-maintenance-windows
-      parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
       responses:
         "200":
           content:
@@ -2005,13 +1961,6 @@ paths:
       description: 立刻恢复告警，哪怕窗口还没到期。
       operationId: delete-maintenance-window
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: windowId
           required: true
@@ -2033,13 +1982,6 @@ paths:
     get:
       operationId: get-maintenance-window
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: windowId
           required: true
@@ -2069,13 +2011,6 @@ paths:
         窗口期内这些机器的问题不告警，也不扣 SLA 的可用率。`server_ids` 留空表示整个项目，包括窗口开着的时候新接进来的机器。
       operationId: put-maintenance-window
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: windowId
           required: true
@@ -2108,14 +2043,6 @@ paths:
     get:
       description: 项目下还没有任何机器时返回各项均为零的总览，而不是 404——空项目是一个正常状态。
       operationId: get-project-overview
-      parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
       responses:
         "200":
           content:
@@ -2136,31 +2063,25 @@ paths:
     get:
       operationId: list-servers
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
-        - description: 这一页最多返回多少条，0 表示用默认值
+        - description: 这一页最多返回多少条
           explode: false
           in: query
           name: limit
           schema:
             default: 50
-            description: 这一页最多返回多少条，0 表示用默认值
+            description: 这一页最多返回多少条
             format: int64
-            maximum: 500
-            minimum: 0
+            maximum: 200
+            minimum: 1
             type: integer
-        - description: 跳过多少条
+        - description: 跳过多少条。要翻得更深请改用游标翻页的接口
           explode: false
           in: query
           name: offset
           schema:
-            description: 跳过多少条
+            description: 跳过多少条。要翻得更深请改用游标翻页的接口
             format: int64
+            maximum: 10000
             minimum: 0
             type: integer
         - description: 按名字或地址模糊匹配
@@ -2186,7 +2107,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/ServerListResponseBody"
+                $ref: "#/components/schemas/LengthAwarePageServerResource"
           description: OK
         default:
           content:
@@ -2202,13 +2123,6 @@ paths:
       description: "**不可逆**：监控主机、历史数据和这台机器名下的告警会一并删除。若只是想暂时停止采集，改用 /disable。"
       operationId: delete-server
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2230,13 +2144,6 @@ paths:
     get:
       operationId: get-server
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2263,13 +2170,6 @@ paths:
       description: 只更新请求体中出现的字段。`address` 与 `address_kind` 必须一并提供：只改其中一个会得到互相矛盾的接入配置，该错误不会被报出，表现为 agent 连不上。
       operationId: update-server
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2307,13 +2207,6 @@ paths:
         响应中的 `tls_psk` **只返回这一次**，请及时保存；遗失后需要轮换。
       operationId: enable-server-monitoring
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2347,13 +2240,6 @@ paths:
       description: 可逆操作：监控主机保留，仅停止采集，历史数据不受影响。重新接入即可恢复采集。如需连同历史数据一并删除，改用 DELETE。
       operationId: disable-server-monitoring
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2377,13 +2263,6 @@ paths:
       description: 原样返回采集到的监控项，不做筛选或重命名。哪些属于重要指标，由调用方依据监控项自带的标签自行判断。
       operationId: list-server-items
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2430,13 +2309,6 @@ paths:
       description: "`item_key` 是**前缀匹配**：按分区、按网卡发现出来的监控项 key 带参数（`vfs.fs.size[/var,pused]`），所以 `vfs.fs.size` 这一个请求就能画出每个挂载点一条线。"
       operationId: get-server-metric
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2506,13 +2378,6 @@ paths:
       description: 换完要同步改 agent 侧的配置，否则那台机器立刻失联。新密钥同样**只在这个响应里明文出现一次**。
       operationId: rotate-agent-psk
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2539,13 +2404,6 @@ paths:
     get:
       operationId: get-server-resources
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2572,13 +2430,6 @@ paths:
     get:
       operationId: get-server-snapshot
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2606,13 +2457,6 @@ paths:
       description: 同时删除监控系统中对应的检查任务和触发器，不会遗留永远无法恢复的告警。
       operationId: delete-web-check
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2640,13 +2484,6 @@ paths:
     get:
       operationId: get-web-check
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2679,13 +2516,6 @@ paths:
       description: "**创建即覆盖**：修改一个检查即用同一个 id 再次调用本接口，无需先判断它是否已存在。"
       operationId: put-web-check
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - in: path
           name: serverId
           required: true
@@ -2728,13 +2558,6 @@ paths:
         `server_id` 为空的那一行是项目整体。
       operationId: get-sli-report
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - explode: false
           in: query
           name: from
@@ -2777,14 +2600,6 @@ paths:
     delete:
       description: 同时移除监控系统中对应的服务树，此后不再统计可用率。
       operationId: delete-slo
-      parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
       responses:
         "204":
           description: No Content
@@ -2800,14 +2615,6 @@ paths:
     get:
       description: 没定过就是 404，而不是一份默认目标：没承诺过和承诺了 99.9% 是两回事。
       operationId: get-slo
-      parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
       responses:
         "200":
           content:
@@ -2830,14 +2637,6 @@ paths:
 
         `min_severity` 必须显式选：它决定什么算「不可用」，是这条承诺的一半内容。
       operationId: put-slo
-      parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
       requestBody:
         content:
           application/json:
@@ -2864,13 +2663,6 @@ paths:
     get:
       operationId: list-project-top-items
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - explode: false
           in: query
           name: kind
@@ -2911,13 +2703,6 @@ paths:
     get:
       operationId: list-web-checks
       parameters:
-        - description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-          in: header
-          name: Authorization
-          required: true
-          schema:
-            description: IAM 签发的项目令牌，形如 Bearer <token>。当前项目由令牌决定，路径上没有 project_id
-            type: string
         - description: 只看某一台机器的检查；不给就是整个项目的
           explode: false
           in: query
@@ -2941,4 +2726,6 @@ paths:
       summary: 列出网页检查
       tags:
         - WebCheck
+security:
+  - bearerAuth: []