インシデント操作記録のクエリ¶
GET /api/v1/incidents/operate/{incident_uuid}/list
概要¶
インシデント操作記録をページネーションで読み取ります。
呼び出し前と使用手順¶
Key は routine.defaultAccess または incidents.incidentsQuery のいずれかに一致する必要があります。現在のワークスペースから読み取ります。パス incident_uuid はインシデント一覧の content.data[].uuid から取得します。createAt の降順、同一の場合は id の降順でページネーションし、デフォルトは pageIndex=1/pageSize=10 です。ページネーション情報はトップレベルの pageInfo にあり、content は data 配列と declaration を含むオブジェクトです。空のリストはインシデントの存在を証明するものではなく、このエンドポイントは親インシデントを事前に検証しません。
インシデント操作履歴を返します。operateType は作成/ステータス/レベル/担当者/通知エスカレーションなどを区別します。content はローカライズされた説明であり、機械的な判断根拠にはなりません。構造化された before/after およびエスカレーション情報は extend にあります。操作記録の書き込みはデフォルトでフォールトトレラントです。リストに記録がないことを、以前にインシデントの変更や通知が発生しなかったことの証明にはできません。クエリ中に追加された記録はオフセットページネーションを移動させるため、uuid で重複排除しながら読み取りを続けます。凍結スナップショットであることは保証しません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| incident_uuid | string | Y | 現在のワークスペースのインシデント UUID です。アラートイベント ID、SLO UUID、コメント UUID ではありません。 null の許可: False 例: incident_example取得または入力方法: インシデント一覧から content.data[].uuid を取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報です。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | オプションの整数で、デフォルトは 1 です。1 以上を推奨します。現在の宣言では正数に制限されていないため、負数でエラーになることを前提にできません。追加/変更中はオフセットページネーションが移動する可能性があります。 null の許可: False 例: 1取得または入力方法: 最初のページから開始し、トップレベルの pageInfo に従って次ページを取得します。 |
|
| pageSize | integer | オプションの整数で、デフォルトは 10 です。現在の実装では最大値が宣言されていないため、呼び出し側は妥当な正数に制限する必要があります。0 や負数は安定したページネーション契約として扱われません。 null の許可: False 例: 10取得または入力方法: クエリ量に応じて選択し、10~100 を推奨します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/incidents/operate/incident_example/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | ページネーションされた内容のオブジェクトです。レコード配列は data に、宣言は declaration にあります。 |
| content.data | array<object> |
このページのレコード配列です。一致するものがない場合は [] です。 |
| content.data[].id | integer または null | データベースの行 ID です。業務上の特定には uuid を使用します。送信前のスナップショットでは null になる場合があります。 |
| content.data[].uuid | string | このリソースの UUID です。 |
| content.data[].status | integer | データベースのステータスで、0 はアクティブ、3 は削除です。インシデントの業務ステータス incidentsStatus とは異なります。 |
| content.data[].creator | string | 作成主体です。API Key の場合は通常 wsak_リソースUUID です。 |
| content.data[].updator | string | 最近の更新主体です。未更新の場合は空になることがあります。 |
| content.data[].createAt | integer | Unix 秒の作成時刻です。 |
| content.data[].updateAt | integer | Unix 秒の最終更新時刻です。 |
| content.data[].deleteAt | integer | Unix 秒の削除時刻です。未削除の場合は -1 です。 |
| content.data[].incidentsUUID | string | 所属するインシデントの UUID です。 |
| content.data[].workspaceUUID | string | 所属するワークスペースです。 |
| content.data[].content | string | ローカライズされた操作説明です。機械的に解析できることは保証されていないため、operateType/extend に基づいて判断します。 |
| content.data[].extend | object | 操作の拡張情報で、operateType に応じて変化します。 |
| content.data[].extend.before | JSON | ステータス/レベル/担当者の変更前の値です。操作タイプによって文字列または配列になります。 |
| content.data[].extend.after | JSON | ステータス/レベル/担当者の変更後の値です。 |
| content.data[].extend.source | string | 操作の発生元です。デフォルトの studio 入口ではこのキーが含まれない場合があります。 |
| content.data[].extend.自定义字段 | JSON | エスカレーションポリシーなどのアクションが持つ拡張メタデータです。元の値を保持し、リクエストパラメータとしては使用しません。 |
| content.data[].operator | string | 実際の操作者のアカウント/Key/システム識別子です。 |
| content.data[].operateType | string | create/status_update/level_update/assigner_update/notify_level_update などです。クライアントは拡張に互換性を持たせる必要があります。 |
| content.data[].creatorInfo | object | 主体の概要です。対応する情報がない場合は {} です。 |
| content.data[].creatorInfo.uuid | string | 主体 UUID です。システム応答の主体は空またはシステム識別子の場合があります。 |
| content.data[].creatorInfo.status | integer | 主体のステータスです。 |
| content.data[].creatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータスです。Key の場合は Key のステータスであり、インシデントのステータスではありません。 |
| content.data[].creatorInfo.username | string | ログイン名/Key 名/システム名です。 |
| content.data[].creatorInfo.name | string | 表示名です。システム AI の表示名はサイト設定を使用します。 |
| content.data[].creatorInfo.iconUrl | string | アバター URL です。システム概要では省略される場合があります。 |
| content.data[].creatorInfo.email | string | 連絡先メールアドレスです。Key の概要では Key UUID になる場合があり、配信可能なメールアドレスではありません。 |
| content.data[].creatorInfo.mobile | string | 連絡先の携帯電話番号です。空の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 国番号です。システム概要では省略される場合があります。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースのニックネームです。システム概要では省略される場合があります。 |
| content.data[].updatorInfo | object | 主体の概要です。対応する情報がない場合は {} です。 |
| content.data[].updatorInfo.uuid | string | 主体 UUID です。システム応答の主体は空またはシステム識別子の場合があります。 |
| content.data[].updatorInfo.status | integer | 主体のステータスです。 |
| content.data[].updatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータスです。Key の場合は Key のステータスであり、インシデントのステータスではありません。 |
| content.data[].updatorInfo.username | string | ログイン名/Key 名/システム名です。 |
| content.data[].updatorInfo.name | string | 表示名です。システム AI の表示名はサイト設定を使用します。 |
| content.data[].updatorInfo.iconUrl | string | アバター URL です。システム概要では省略される場合があります。 |
| content.data[].updatorInfo.email | string | 連絡先メールアドレスです。Key の概要では Key UUID になる場合があり、配信可能なメールアドレスではありません。 |
| content.data[].updatorInfo.mobile | string | 連絡先の携帯電話番号です。空の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 国番号です。システム概要では省略される場合があります。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースのニックネームです。システム概要では省略される場合があります。 |
| content.data[].operatorInfo | object | 主体の概要です。対応する情報がない場合は {} です。 |
| content.data[].operatorInfo.uuid | string | 主体 UUID です。システム応答の主体は空またはシステム識別子の場合があります。 |
| content.data[].operatorInfo.status | integer | 主体のステータスです。 |
| content.data[].operatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータスです。Key の場合は Key のステータスであり、インシデントのステータスではありません。 |
| content.data[].operatorInfo.username | string | ログイン名/Key 名/システム名です。 |
| content.data[].operatorInfo.name | string | 表示名です。システム AI の表示名はサイト設定を使用します。 |
| content.data[].operatorInfo.iconUrl | string | アバター URL です。システム概要では省略される場合があります。 |
| content.data[].operatorInfo.email | string | 連絡先メールアドレスです。Key の概要では Key UUID になる場合があり、配信可能なメールアドレスではありません。 |
| content.data[].operatorInfo.mobile | string | 連絡先の携帯電話番号です。空の場合があります。 |
| content.data[].operatorInfo.countryCode | string | 国番号です。システム概要では省略される場合があります。 |
| content.data[].operatorInfo.acntWsNickname | string | ワークスペースのニックネームです。システム概要では省略される場合があります。 |
| content.data[].extend.before_info | object または array | 変更前のレベル概要または担当者概要の配列です。ステータス変更では通常 {} で、レベルの before 自体は表示名です。 |
| content.data[].extend.after_info | object または array | 変更後のレベル/担当者概要です。実際の operateType と型に応じて読み取ります。 |
| content.data[].extend.schedule_name | string | 通知エスカレーション操作におけるオンコール/ポリシー名の概要です。 |
| content.data[].extend.incidents_status | string | 通知エスカレーション時のインシデント業務ステータスです。 |
| content.data[].extend.strategy_info | object | 通知エスカレーションポリシーのスナップショットです。 |
| content.data[].extend.strategy_info.name | string | 所属するスケジュール名です。 |
| content.data[].extend.strategy_info.strategy | object | 今回選択されたレベルおよび通知設定のスナップショットです。 |
| content.data[].extend.notify_info | object | 通知対象の識別子から、その時点の対象情報へのマッピングです。アカウント/グループ/通知対象によって形状が異なります。 |
| content.data[].extend.notify_info.目标标识 | object または string | その対象の当時の名前/メールアドレス/メンバーなどの情報です。実際の型に応じて読み取ります。正常な配信を意味するものではありません。 |
| content.data[].extend.is_muted | boolean | インシデント通知のミュートに該当する場合は true です。エスカレーション記録があっても実際には送信されていません。 |
| content.data[].extend.mute_rule_info | object | 該当したミュートルールの概要です。 |
| content.data[].extend.mute_rule_info.uuid | string | ミュートルールの UUID です。 |
| content.data[].extend.mute_rule_info.name | string | ミュートルール名です。 |
| content.data[].extend.muted_notify_info | object | 送信が予定されていたもののミュートされた対象情報のマッピングです。 |
| content.data[].extend.muted_notify_info.目标标识 | object または string | ミュートされた対象情報です。 |
| content.data[].extend.strategy_info.strategy.level | integer | レベルの連番で、通常は 0 から始まります。 |
| content.data[].extend.strategy_info.strategy.levelUpTime | integer | インシデントステータスのトリガー時刻からのエスカレーション待ち秒数です。 |
| content.data[].extend.strategy_info.strategy.incidentsLevel | array<string> |
適用されるインシデントレベルの UUID リストです。 |
| content.data[].extend.strategy_info.strategy.incidentsLevel[] | string | 1 つのレベル UUID です。 |
| content.data[].extend.strategy_info.strategy.incidentsStatus | array<string> |
適用されるインシデントステータスのリストです(例: open/working)。 |
| content.data[].extend.strategy_info.strategy.incidentsStatus[] | string | 1 つのインシデントステータスです。 |
| content.data[].extend.strategy_info.strategy.ifRepeatNotify | boolean | 繰り返し通知を行うかどうかです。 |
| content.data[].extend.strategy_info.strategy.repeatNotifyInterval | integer | 繰り返し通知の間隔(秒)です。 |
| content.data[].extend.strategy_info.strategy.notifyConfig | array<object> |
このレベルの通知設定の配列です。 |
| content.data[].extend.strategy_info.strategy.notifyConfig[].notifyObjectType | string | 通知対象の分類です(例: member/object/group)。保存されたバージョンに従って読み取ります。 |
| content.data[].extend.strategy_info.strategy.notifyConfig[].notifyObject | array<string> |
通知対象の識別子です。watchkeeper は実行時の現在のオンコール担当者を表し、固定のアカウント UUID ではありません。 |
| content.data[].extend.strategy_info.strategy.notifyConfig[].notifyObject[] | string | 1 つの対象アカウント/グループ/通知対象の識別子、または watchkeeper です。 |
| content.data[].extend.strategy_info.strategy.notifyConfig[].notifyMethod | array<string> |
通知方法です。一般的には mobile は電話、message は SMS、email はメールです。対象チャネルは対象の設定に従って実行されます。 |
| content.data[].extend.strategy_info.strategy.notifyConfig[].notifyMethod[] | string | 1 つの通知方法です。 |
| content.declaration | object | 現在のワークスペースの共通宣言です。data の各項目に再帰的に挿入されることはありません。 |
| pageInfo.pageIndex | integer | 現在のページで、デフォルトは 1 です。 |
| pageInfo.pageSize | integer | 現在のページサイズで、デフォルトは 10 です。 |
| pageInfo.count | integer | このページの件数です。 |
| pageInfo.totalCount | integer | 一致する総件数です。変更中は変わる可能性があります。 |
{
"code": 200,
"content": {
"data": [
{
"uuid": "incop_example",
"incidentsUUID": "incident_example",
"workspaceUUID": "wksp_example",
"content": "触发了新的故障",
"extend": {},
"operator": "wsak_example",
"operateType": "create",
"id": 123,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creatorInfo": {},
"updatorInfo": {},
"operatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反した場合 | パラメータ解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴オブジェクト/設定形式、関連概要の構築などで未処理の例外が発生した場合 | 内部エラー | クエリパラメータを確認し、traceId を保持してください。バックオフして再試行できます。失敗が続く場合は、管理者が関連する履歴レコードとサービスログを確認してください。 |