一覧¶
POST /api/v1/incidents/list
概要¶
現在のワークスペースのインシデントおよび直近の操作/オンコール一致サマリーをページングして照会します。
呼び出し前の前提と使用手順¶
Key は routine.defaultAccess または incidents.incidentsQuery のいずれかに一致する必要があります。現在の API Key が属するワークスペースのみを操作します。本モジュールのインシデント UUID はインシデント一覧の content.data[].uuid から取得し、通常は incident_ プレフィックスです。公開エントリポイントは workspaceUUID/workspaceUUIDs を受け付けないため、フロントエンド/内部インターフェースのクロスワークスペースパラメーターをそのまま流用しないでください。
POST で JSON オブジェクトを送信します。{} の場合は作成時間と id の降順で一覧表示されます。デフォルトは pageIndex=1/pageSize=10 です。ページング情報は最上位の pageInfo にあり、content はオブジェクトとして保持され、インシデント配列は content.data、共通宣言は content.declaration に含まれます。data の各項目に再帰的に挿入されることはありません。照会中に追加/変更があるとオフセットページングが移動するため、uuid で重複排除し、必要に応じて timeRange を固定してください。
filters の 3 要素の組み合わせが推奨される絞り込み方法です。複数条件は AND、通常フィールドで同じ条件の配列は OR、assigner の複数値は AND、tags は関連付けのいずれかに一致した場合にヒットします。最上位の incidentsStatus は現在、データベースの status に誤って接続されており、最上位の assigner は古い JSON.manager パスを照会するため、業務上の想定と異なる可能性があります。省略して filters を使用してください。宣言上入力可能であっても、互換フィールドが信頼できることを保証するものではありません。未知の filters.field(project など)は明確に 406 となり、未知の op は黙って無視される場合があります。timeRange はインシデント活動の対象期間条件であり、作成時間または更新時間だけで絞り込むものではありません。
一覧では resourceContent が削除され、添付ファイル/metrics/upgradeInfo は含まれません。これらが必要な場合は詳細インターフェースを使用してください。scheduleInfo は一致した設定のみを表し、現在の当番者や通知の到達を保証するものではありません。タグのみのスケジュールはこの一覧ではいずれかのタグに一致するとヒットし、詳細の全タグ一致とは互換性の差異があります。一致しない場合は content.data=[] と完全な pageInfo を返します。
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト Body パラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| timeRange[*] | integer | 開始/終了の 2 つの数値のいずれか。 例: 1785427200000取得または入力方法: 時間セレクターで生成された Unix ミリ秒。 |
|
| filters[*] | object | 1 つのフィルターの三つ組。field がない場合は非サポートとして報告され、誤ったオブジェクト/型は 500 になる可能性があります。 例: {"field": "incidentsStatus", "op": "=", "value": ["open", "working"]}取得または入力方法: filters と同じ取得元。 |
|
| filters[*].field | string | 推奨: tags/incidentsStatus/level/assigner/schedule/resourceType/aggregationRuleUUID、および host/service/resource/pod_name/app_name/app_id/env/url。先頭 8 つのディメンションはインデックス列にマッピングされ、project などの未知のフィールドは 406 になります。実装は実際のエンティティ列にも互換性がありますが、顧客向け照会で内部列に依存することは避けてください。 例: incidentsStatus取得または入力方法: 業務で絞り込み可能なフィールドを選択します。 |
|
| filters[*].op | string | 任意で = または != を指定でき、省略時は = です。その他の演算子は使用しません。 例: =取得または入力方法: 包含/除外に応じて選択します。 |
|
| filters[*].value | array | 通常フィールドの複数値は OR、assigner の複数値は項目ごとに AND(すべて含める/すべて除外する必要があります)、tags の複数値はいずれかの関連付けに一致、schedule はスケジュールの一致集合、集約ルールは extend.aggregationRuleUUID に対応する UUID を指定します。空配列は操作なしを意味しないため、条件全体を省略することを推奨します。 例: ["open", "working"]取得または入力方法: field に応じて同じ型の値を入力します。通常は文字列配列です。 |
|
| filters[*].value[*] | string | 1 つの文字列値。業務ステータスは open/working/resolved/closed、level はレベル UUID、tags はタグ UUID です。 例: open取得または入力方法: field に応じて有効な識別子/ディメンション値を選択します。 |
|
| incidentsStatus[*] | string | 単一条件の文字列。セマンティクスは親フィールドと同じです。 例: open取得または入力方法: 業務ステータスが必要な場合は、filters の field=incidentsStatus を優先してください。 |
|
| level[*] | string | 単一条件の文字列。セマンティクスは親フィールドと同じです。 例: system_level_1取得または入力方法: インシデントレベル一覧から uuid を取得します。バックエンドでグローバルレベルが有効な場合は、管理者に実際に有効なレベルを確認する必要があります。 |
|
| assigner[*] | string | 単一条件の文字列。セマンティクスは親フィールドと同じです。 例: acnt_example取得または入力方法: メンバー一覧からアカウント UUID を取得します。グループ/通知先は対応する一覧から取得し、同じワークスペースに属し利用可能であることを確認してください。 |
|
| tags[*] | string | 単一条件の文字列。セマンティクスは親フィールドと同じです。 例: tag_example取得または入力方法: タグ一覧から uuid を取得します。tags への書き込みでは名前を使用する点と区別してください。 |
|
| schedule[*] | string | 単一条件の文字列。セマンティクスは親フィールドと同じです。 例: incsch_example取得または入力方法: オンコールスケジュール管理からスケジュール UUID を取得します。 |
|
| assigner | array | 互換用の最上位パラメーターです。現在は履歴 JSON のパス $.manager を照会しますが、インシデントでは配列として保存されることが一般的です。省略し、filters.assigner で絞り込むことを推奨します。 null を許可: False 例: ["acnt_example"]取得または入力方法: メンバー一覧からアカウント UUID を取得します。グループ/通知先は対応する一覧から取得し、同じワークスペースに属し利用可能であることを確認してください。 |
|
| filters | array | 任意の条件オブジェクト配列。複数条件は AND です。同じ通常フィールドの value 配列は通常 IN/NOT IN です。= と != のみが実際に有効で、その他の op は無視される場合があり、そのエラー報告に依存しないでください。最上位の incidentsStatus/assigner 互換フィールドの代わりに filters を使用することを推奨します。 null を許可: False 例: [{"field": "incidentsStatus", "op": "=", "value": ["open", "working"]}]取得または入力方法: 本文でサポートされるフィールドに従い、業務ステータス、レベル、メンバー、タグ、オンコール、またはインシデントのディメンションから構築します。 |
|
| incidentsStatus | array | 互換用の最上位パラメーターです。現在の実装では業務上の incidentsStatus ではなくデータベースの status 列に誤って使用されているため、open/working による絞り込みに依存できません。省略し、filters を使用することを推奨します。 null を許可: False 例: ["open"]取得または入力方法: 業務ステータスが必要な場合は、filters の field=incidentsStatus を優先してください。 |
|
| level | array | 任意のレベル UUID 配列。複数指定は OR、省略/[] は制限なしです。 null を許可: False 例: ["system_level_1"]取得または入力方法: インシデントレベル一覧から uuid を取得します。バックエンドでグローバルレベルが有効な場合は、管理者に実際に有効なレベルを確認する必要があります。 |
|
| pageIndex | integer | 任意の整数。デフォルトは 1、1 以上を推奨します。現在の宣言では正数に制限されていないため、負数でエラーになることに依存できません。追加/変更中はオフセットページングが移動する可能性があります。 null を許可: False 例: 1取得または入力方法: 最初のページから開始し、最上位の pageInfo に従って次ページを取得します。 |
|
| pageSize | integer | 任意の整数。デフォルトは 10 です。現在の実装では最大値が宣言されていないため、呼び出し側は妥当な正数に制限してください。0/負数は安定したページング契約として扱われません。 null を許可: False 例: 10取得または入力方法: 照会量に応じて選択し、10 から 100 を推奨します。 |
|
| schedule | array | 任意のスケジュール UUID 配列。スケジュールのタグ/ディメンション条件に一致するインシデントを照会し、結果をマージします。現在のシフトメンバーや通知済みかどうかで絞り込むものではありません。一致しない場合は空の一覧になります。 null を許可: False 例: ["incsch_example"]取得または入力方法: オンコールスケジュール管理からスケジュール UUID を取得します。 |
|
| search | string | 任意の名称 LIKE 部分一致。省略/空文字列の場合は絞り込みません。現在、%/_ は SQL のワイルドカードとして作用する可能性があり、全文検索ではありません。 null を許可: False 例: 支付取得または入力方法: インシデント名に基づいてキーワードを入力します。 |
|
| tags | array | 任意のタグ UUID 配列。いずれかの関連タグに一致した場合にヒットします。省略/[] は制限なしで、一致しない場合は空の一覧を返します。 null を許可: False 例: ["tag_example"]取得または入力方法: タグ一覧から uuid を取得します。tags への書き込みでは名前を使用する点と区別してください。 |
|
| timeRange | array | 任意の長さが正確に 2 の数値配列。省略/[] の場合は時間で絞り込みません。createAt<=終了 かつ max(eventUpdateAt,createAt)>=開始 で絞り込み、作成時間だけを照会するものではなく、更新時間 updateAt で絞り込むものでもありません。現在のルートは array のみを検証するため、長さ/要素の誤りは 500 になる可能性があります。開始/終了を事前に検証してください。 null を許可: False 例: [1785340800000, 1785427200000]取得または入力方法: 呼び出し側がインシデント活動の対象期間を選択します。Unix ミリ秒です。 |
パラメーター補足説明¶
filters は = と != をサポートし、複数条件は AND です。セマンティクスに異常がある最上位の互換フィールドの代わりに、filters.incidentsStatus/assigner を使用してください。ディメンション host/service/resource/pod_name/app_name/app_id/env/url はインデックス列にマッピングされ、集約インシデントは resourceType=incident_aggregation と aggregationRuleUUID で絞り込めます。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/incidents/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"pageIndex":1,"pageSize":10,"filters":[{"field":"incidentsStatus","op":"=","value":["open","working"]}]}'
レスポンス¶
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[].workspaceUUID | string | インシデントが属するワークスペース。 |
| content.data[].name | string | インシデント名。 |
| content.data[].level | string | インシデントレベルの UUID。system_level_0 など、または issl_/isslm_ の履歴識別子。レベルの表示名とは異なります。 |
| content.data[].description | string または null | インシデントの説明。 |
| content.data[].source | string | インシデントのソース。この公開エントリポイントで手動作成した場合は現在 external となり、External API 認証を使用したことを示すものではありません。 |
| content.data[].resourceCategory | string | ソースリソースカテゴリ。自動インシデントはソースに応じて設定され、公開エントリポイントでの手動作成では通常空です。 |
| content.data[].resourceType | string | ソースリソースタイプ。集約インシデントは incident_aggregation、手動作成では通常空です。 |
| content.data[].resourceUUID | string | ソースリソース UUID。手動作成では通常空です。 |
| content.data[].resourceUrl | string | 保存されたソース URL。レスポンスフィールドでは先頭の l が小文字であり、リクエストの resourceURL と区別します。 |
| content.data[].eventRelations | array<object> |
現在のインシデントライフサイクルに関連付けられたイベントのスナップショット。再度オープンして新しいラウンドになるとクリアされる場合があります。 |
| content.data[].eventRelations[] | object | ソースイベントの関連付け記述。イベントタイプに応じて動的フィールドが返され、本インターフェースでインシデントを作成する際に設定可能なオブジェクトではありません。 |
| content.data[].eventRelations[].自定义字段 | JSON | イベント生成側が保存した関連付けキー/値。まず実際の型に従って読み取ってください。 |
| content.data[].resourceIdentity | string | ソースの集約/子識別子。手動作成では空になる場合があります。 |
| content.data[].assigner | array<string> |
処理担当者識別子の一覧。acnt_/group_/notify_ を含む場合があります。すべての識別子が現在も有効であることは保証されません。 |
| content.data[].assigner[] | string | 保存された処理担当者/グループ/通知先の識別子 1 つ。 |
| content.data[].incidentsStatus | string | 業務ステータス open/working/resolved/closed。 |
| content.data[].statusTime | object | 現在のライフサイクルで記録されたステータス時間(Unix 秒)。すべてのステータスが存在するわけではありません。 |
| content.data[].statusTime.open | integer | 今回のオープン時間。 |
| content.data[].statusTime.working | integer | 今回の処理開始時間。省略される場合があります。 |
| content.data[].statusTime.resolved | integer | 今回の復旧時間。省略される場合があります。 |
| content.data[].statusTime.closed | integer | 今回のクローズ時間。省略される場合があります。 |
| content.data[].statusChangeTime | integer | 現在のライフサイクルのトリガー時間。再オープン時に更新されます。各フィールドの変更時間とは同じではありません。 |
| content.data[].cumulativeTime | integer | 累計のインシデント継続秒数。詳細/一覧では現在のステータスを組み合わせてリアルタイムに計算され、書き込みレスポンスでは保存値になる場合があります。 |
| content.data[].eventCount | integer | 関連イベント数。手動作成では通常 0 です。 |
| content.data[].eventUpdateAt | integer | ソースの最終イベント更新時間(Unix 秒)。手動作成では通常 0 です。 |
| content.data[].dimensionTag | object | ディメンション名から値への JSON マッピング。 |
| content.data[].dimensionTag.自定义键 | JSON | 呼び出し側またはソースが保存したディメンション値。文字列を推奨します。host/service などには別途インデックスフィールドがあります。 |
| content.data[].extend | object または JSON | インシデント拡張データ。自動ソースでは集約/イベントなどの設定が付随する場合があります。作成公開エントリポイントでは現在、渡された extend を保存せず、変更時のみ全体を置き換えられます。 |
| content.data[].extend.linkList | array<object> |
業務リンク配列。保存後の表示用途であり、本インターフェースが外部 URL にアクセスするものではありません。 |
| content.data[].extend.linkList[].name | string | リンク表示名。 |
| content.data[].extend.linkList[].link | string | リンクアドレス。 |
| content.data[].extend.aggregationRuleUUID | string | 集約ソースのルール UUID。存在する場合は filters.aggregationRuleUUID に使用できます。 |
| content.data[].extend.自定义字段 | JSON | その他保存されたソース拡張フィールド。固定構造は保証されません。全体を置き換える前に既存オブジェクト全体をコピーしてください。 |
| content.data[].dtHost | string または null | host インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].dtService | string または null | service インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].dtResource | string または null | resource インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].dtPodName | string または null | pod_name インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].dtAppName | string または null | app_name インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].dtAppId | string または null | app_id インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].dtEnv | string または null | env インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].dtUrl | string または null | url インデックスディメンション。作成時の dimensionTag に由来します。変更公開エントリポイントの dimensionTag は現在反映されません。 |
| content.data[].eventRelations[].df_fault_id | string | イベントライフサイクル ID。イベントの df_fault_id または互換の df_status_fault_id から生成されます。インシデント uuid ではありません。 |
| content.data[].eventRelations[].status | string | この関連イベントスナップショットの df_status ステータス(critical/ok など)。インシデントの incidentsStatus とは異なります。 |
| content.data[].eventRelations[].aggregationValues | object | 集約ルールによる関連付けの場合にのみ存在可能。集約キーから対応するイベントディメンション値へのマッピングです。 |
| content.data[].eventRelations[].aggregationValues.聚合键 | JSON | 集約ルールで指定されたディメンションのイベント内の値。実際に保存された型に従って読み取ってください。 |
| content.data[].assignerInfo | array<object> |
実際に解決に成功した処理担当者のサマリー。アカウントは完全な ID フィールドを含み、グループ/通知先は uuid/name のみを含みます。未知の識別子は無視される場合があります。 |
| content.data[].assignerInfo[].uuid | string | 主体 UUID。システム応答の主体は空またはシステム識別子になる場合があります。 |
| content.data[].assignerInfo[].status | integer | 主体ステータス。 |
| content.data[].assignerInfo[].wsAccountStatus | integer | ワークスペースメンバーステータス。Key の場合は Key ステータスを取得し、インシデントステータスではありません。 |
| content.data[].assignerInfo[].username | string | ログイン名/Key 名/システム名。 |
| content.data[].assignerInfo[].name | string | 表示名。システム AI の表示名はサイト設定を使用します。 |
| content.data[].assignerInfo[].iconUrl | string | アバター URL。システムサマリーでは省略される場合があります。 |
| content.data[].assignerInfo[].email | string | 連絡先メールアドレス。Key サマリーの場合は Key UUID であり、配信可能なメールアドレスではない可能性があります。 |
| content.data[].assignerInfo[].mobile | string | 連絡先携帯電話番号。空になる場合があります。 |
| content.data[].assignerInfo[].countryCode | string | 国番号。システムサマリーでは省略される場合があります。 |
| content.data[].assignerInfo[].acntWsNickname | string | ワークスペース内ニックネーム。システムサマリーでは省略される場合があります。 |
| content.data[].workspaceInfo | object | インシデントが属するワークスペースのサマリー。 |
| content.data[].workspaceInfo.uuid | string | 所属ワークスペースの UUID。 |
| content.data[].workspaceInfo.name | string | ワークスペース名。解決できない場合は空になることがあります。 |
| content.data[].regionCode | string | 現在のサイトコード。 |
| content.data[].isExternalWorkspace | boolean | 他のワークスペース由来かどうか。この OpenAPI 公開エントリポイントはクロスワークスペースのターゲットを受け付けないため、通常は false です。 |
| content.data[].aggregationRuleInfo | object または null | 集約インシデントにのみ付加され、有効なルールのサマリーまたは null です。 |
| content.data[].aggregationRuleInfo.uuid | string | 集約ルール UUID。 |
| content.data[].aggregationRuleInfo.name | string | 集約ルール名。 |
| content.data[].aggregationRuleInfo.status | integer | ルールのデータベースステータス。 |
| content.data[].scheduleInfo | array<object> |
現在一致したオンコール設定の生サマリー。現時点で当番者がいることや通知が実際に配信されたことを示すものではありません。詳細と一覧ではタグ一致の互換ルールに差異があります。 |
| content.data[].scheduleInfo[].id | integer または null | データベース行 ID。業務上の特定には uuid を使用します。送信前のスナップショットでは null になる場合があります。 |
| content.data[].scheduleInfo[].uuid | string | このリソースの UUID。 |
| content.data[].scheduleInfo[].status | integer | データベースステータス。0 はアクティブ/3 は削除。インシデントの業務ステータス incidentsStatus とは異なります。 |
| content.data[].scheduleInfo[].creator | string | 作成主体。API Key の場合は通常 wsak_ リソース UUID です。 |
| content.data[].scheduleInfo[].updator | string | 最終更新主体。未更新の場合は空になることがあります。 |
| content.data[].scheduleInfo[].createAt | integer | Unix 秒の作成時間。 |
| content.data[].scheduleInfo[].updateAt | integer | Unix 秒の最終更新時間。 |
| content.data[].scheduleInfo[].deleteAt | integer | Unix 秒の削除時間。未削除の場合は -1。 |
| content.data[].scheduleInfo[].workspaceUUID | string | 所属ワークスペース。 |
| content.data[].scheduleInfo[].name | string | オンコール名。 |
| content.data[].scheduleInfo[].timezone | string | IANA タイムゾーン。 |
| content.data[].scheduleInfo[].start | string | 互換用の毎日の勤務開始時刻 HH:MM。スケジュールの timezone に従って解釈され、日付や Unix 時間ではありません。 |
| content.data[].scheduleInfo[].end | string | 互換用の毎日の勤務終了時刻 HH:MM。有効な日付境界は別途 extend.effectiveTime を参照してください。 |
| content.data[].scheduleInfo[].tagFilter | array<string> |
一致するタグ UUID 配列。 |
| content.data[].scheduleInfo[].tagFilter[] | string | タグ UUID。 |
| content.data[].scheduleInfo[].dimensionFilter | string | ディメンション一致のクエリ式。 |
| content.data[].scheduleInfo[].notifyTargets | array<string> |
通知先識別子の一覧。 |
| content.data[].scheduleInfo[].notifyTargets[] | string | アカウント/グループ/通知先などのターゲット識別子。 |
| content.data[].scheduleInfo[].strategyConfig | array<object> |
エスカレーションポリシー設定。ワークスペースに保存されたバージョンに従って読み取ります。 |
| content.data[].scheduleInfo[].strategyConfig[] | object | 1 つの設定ポリシー。インシデント読み取りインターフェースでは実行プレビューを展開しません。 |
| content.data[].scheduleInfo[].strategyConfig[].自定义字段 | JSON | 保存されたポリシーレベル/待機/通知設定。完全な業務設定はオンコール管理で読み取ってください。 |
| content.data[].scheduleInfo[].extend | object | シフト/ローテーションなどの拡張設定。 |
| content.data[].scheduleInfo[].extend.自定义字段 | JSON | 保存されたオンコール拡張キー/値。本インターフェースでは変更できません。 |
| content.data[].scheduleInfo[].isDefault | boolean | デフォルトのオンコールかどうか。 |
| content.data[].scheduleInfo[].rotationUpdateAt | integer | ローテーション変更の Unix 秒時間。履歴では -1 になる場合があります。 |
| content.data[].scheduleInfo[].agentUUIDs | array<string> |
拡張内の関連 Agent UUID 配列。 |
| content.data[].scheduleInfo[].agentUUIDs[] | string | 1 つの Agent UUID。 |
| content.data[].scheduleInfo[].strategyConfig[].uuid | string | ポリシー UUID。 |
| content.data[].scheduleInfo[].strategyConfig[].name | string | ポリシー名。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy | array<object> |
このポリシーのエスカレーション階層設定配列。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].level | integer | 階層番号。通常は 0 から始まります。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].levelUpTime | integer | インシデントステータスのトリガー時間からのエスカレーション待機秒数。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsLevel | array<string> |
適用されるインシデントレベル UUID の一覧。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsLevel[] | string | 1 つのレベル UUID。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsStatus | array<string> |
適用されるインシデントステータスの一覧(open/working など)。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].incidentsStatus[] | string | 1 つのインシデントステータス。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].ifRepeatNotify | boolean | 繰り返し通知するかどうか。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].repeatNotifyInterval | integer | 繰り返し通知の間隔(秒)。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig | array<object> |
この階層の通知設定配列。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObjectType | string | 通知先の分類(member/object/group など)。保存されたバージョンに従って読み取ります。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObject | array<string> |
通知先識別子。watchkeeper は実行時の現在のオンコール担当者を表し、固定のアカウント UUID ではありません。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObject[] | string | 1 つのターゲットアカウント/グループ/通知先識別子、または watchkeeper。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyMethod | array<string> |
通知方法。一般的に mobile は電話、message は SMS、email はメールです。オブジェクトチャネルはオブジェクト設定に従って実行されます。 |
| content.data[].scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyMethod[] | string | 1 つの通知方法。 |
| content.data[].scheduleInfo[].extend.enableRotateNotification | boolean | 通知先をローテーションするかどうか。 |
| content.data[].scheduleInfo[].extend.rotationCycle | string | day/week/month/workDay/weekend/customDay/customWeek のいずれか。履歴では省略される場合があります。 |
| content.data[].scheduleInfo[].extend.rotationInterval | integer | customDay のローテーション間隔日数は 1~31、customWeek の週数は 1~4 です。 |
| content.data[].scheduleInfo[].extend.effectiveTime | object | スケジュール有効期間の設定。 |
| content.data[].scheduleInfo[].extend.effectiveTime.start | integer | 保存された有効開始 Unix 秒。省略時は開始制限を設定しません。 |
| content.data[].scheduleInfo[].extend.effectiveTime.end | integer | 保存された有効終了 Unix 秒。省略時は終了制限を設定しません。 |
| content.data[].scheduleInfo[].extend.workTime | object | 勤務時間設定。省略時は互換 start/end とローテーション周期から導出されます。 |
| content.data[].scheduleInfo[].extend.workTime.mode | string | allDay は終日、specificTimes は指定時間です。 |
| content.data[].scheduleInfo[].extend.workTime.periods | array<object> |
指定勤務時間帯の配列。 |
| content.data[].scheduleInfo[].extend.workTime.periods[].weekdays | array<integer> |
適用する曜日。1 は月曜日から 7 は日曜日です。 |
| content.data[].scheduleInfo[].extend.workTime.periods[].weekdays[] | integer | 1~7 のいずれか。 |
| content.data[].scheduleInfo[].extend.workTime.periods[].start | string | 現地日付の開始 HH:MM。 |
| content.data[].scheduleInfo[].extend.workTime.periods[].end | string | 現地日付の終了 HH:MM。 |
| content.data[].scheduleInfo[].extend.agentUUIDs | array<string> |
関連 Agent UUID。エンティティには別途トップレベルの agentUUIDs 投影があります。 |
| content.data[].scheduleInfo[].extend.agentUUIDs[] | string | 1 つの Agent UUID。 |
| content.data[].operateRecord | object | 直近の操作記録サマリー。記録がない場合でも operatorInfo={} が存在する場合があります。 |
| content.data[].operateRecord.uuid | string | 操作記録 UUID。 |
| content.data[].operateRecord.createAt | integer | 記録の Unix 秒時間。 |
| content.data[].operateRecord.incidentsUUID | string | 所属インシデント UUID。 |
| content.data[].operateRecord.workspaceUUID | string | 所属ワークスペース。 |
| content.data[].operateRecord.content | string | ローカライズされた操作説明。機械可読であることは保証されないため、operateType/extend に基づいて判断してください。 |
| content.data[].operateRecord.extend | object | 操作拡張。operateType に応じて変化します。 |
| content.data[].operateRecord.extend.before | JSON | ステータス/レベル/処理担当者の変更前の値。操作タイプに応じて文字列または配列になる場合があります。 |
| content.data[].operateRecord.extend.after | JSON | ステータス/レベル/処理担当者の変更後の値。 |
| content.data[].operateRecord.extend.source | string | 操作ソース。デフォルトの studio エントリポイントではこのキーを含まない場合があります。 |
| content.data[].operateRecord.extend.自定义字段 | JSON | エスカレーションポリシーなどのアクションが持つ拡張メタデータ。元の値を保持し、リクエストパラメーターとしては使用しません。 |
| content.data[].operateRecord.operator | string | 実際の操作者のアカウント/Key/システム識別子。 |
| content.data[].operateRecord.operateType | string | create/status_update/level_update/assigner_update/notify_level_update など。クライアントは拡張に互換性を持たせる必要があります。 |
| content.data[].operateRecord.operatorInfo | object | 主体サマリー。対応する情報がない場合は {} です。 |
| content.data[].operateRecord.operatorInfo.uuid | string | 主体 UUID。システム応答の主体は空またはシステム識別子になる場合があります。 |
| content.data[].operateRecord.operatorInfo.status | integer | 主体ステータス。 |
| content.data[].operateRecord.operatorInfo.wsAccountStatus | integer | ワークスペースメンバーステータス。Key の場合は Key ステータスを取得し、インシデントステータスではありません。 |
| content.data[].operateRecord.operatorInfo.username | string | ログイン名/Key 名/システム名。 |
| content.data[].operateRecord.operatorInfo.name | string | 表示名。システム AI の表示名はサイト設定を使用します。 |
| content.data[].operateRecord.operatorInfo.iconUrl | string | アバター URL。システムサマリーでは省略される場合があります。 |
| content.data[].operateRecord.operatorInfo.email | string | 連絡先メールアドレス。Key サマリーの場合は Key UUID であり、配信可能なメールアドレスではない可能性があります。 |
| content.data[].operateRecord.operatorInfo.mobile | string | 連絡先携帯電話番号。空になる場合があります。 |
| content.data[].operateRecord.operatorInfo.countryCode | string | 国番号。システムサマリーでは省略される場合があります。 |
| content.data[].operateRecord.operatorInfo.acntWsNickname | string | ワークスペース内ニックネーム。システムサマリーでは省略される場合があります。 |
| content.data[].operateRecord.extend.before_info | object または array | 変更前のレベルサマリーまたは処理担当者サマリー配列。ステータス変更では通常 {}、レベルの before 自体は表示名です。 |
| content.data[].operateRecord.extend.after_info | object または array | 変更後のレベル/処理担当者サマリー。実際の operateType と型に従って読み取ってください。 |
| content.data[].operateRecord.extend.schedule_name | string | 通知エスカレーション操作におけるオンコール/ポリシー名のサマリー。 |
| content.data[].operateRecord.extend.incidents_status | string | 通知エスカレーション時のインシデント業務ステータス。 |
| content.data[].operateRecord.extend.strategy_info | object | 通知エスカレーションポリシーのスナップショット。 |
| content.data[].operateRecord.extend.strategy_info.name | string | 所属スケジュール名。 |
| content.data[].operateRecord.extend.strategy_info.strategy | object | 今回選択された階層と通知設定のスナップショット。 |
| content.data[].operateRecord.extend.notify_info | object | 通知先識別子からその時点のターゲット情報へのマッピング。アカウント/グループ/通知先で形状が異なります。 |
| content.data[].operateRecord.extend.notify_info.目标标识 | object または string | そのターゲットの当時の名前/メール/メンバーなどの情報。実際の型に従って読み取ってください。配信成功を示すものではありません。 |
| content.data[].operateRecord.extend.is_muted | boolean | インシデント通知のミュートに一致した場合は true。エスカレーション記録があっても実際には送信されていません。 |
| content.data[].operateRecord.extend.mute_rule_info | object | 一致したミュートルールのサマリー。 |
| content.data[].operateRecord.extend.mute_rule_info.uuid | string | ミュートルール UUID。 |
| content.data[].operateRecord.extend.mute_rule_info.name | string | ミュートルール名。 |
| content.data[].operateRecord.extend.muted_notify_info | object | 送信予定だったがミュートされたターゲット情報のマッピング。 |
| content.data[].operateRecord.extend.muted_notify_info.目标标识 | object または string | ミュートされたターゲット情報。 |
| content.data[].operateRecord.extend.strategy_info.strategy.level | integer | 階層番号。通常は 0 から始まります。 |
| content.data[].operateRecord.extend.strategy_info.strategy.levelUpTime | integer | インシデントステータスのトリガー時間からのエスカレーション待機秒数。 |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsLevel | array<string> |
適用されるインシデントレベル UUID の一覧。 |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsLevel[] | string | 1 つのレベル UUID。 |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsStatus | array<string> |
適用されるインシデントステータスの一覧(open/working など)。 |
| content.data[].operateRecord.extend.strategy_info.strategy.incidentsStatus[] | string | 1 つのインシデントステータス。 |
| content.data[].operateRecord.extend.strategy_info.strategy.ifRepeatNotify | boolean | 繰り返し通知するかどうか。 |
| content.data[].operateRecord.extend.strategy_info.strategy.repeatNotifyInterval | integer | 繰り返し通知の間隔(秒)。 |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig | array<object> |
この階層の通知設定配列。 |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObjectType | string | 通知先の分類(member/object/group など)。保存されたバージョンに従って読み取ります。 |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObject | array<string> |
通知先識別子。watchkeeper は実行時の現在のオンコール担当者を表し、固定のアカウント UUID ではありません。 |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObject[] | string | 1 つのターゲットアカウント/グループ/通知先識別子、または watchkeeper。 |
| content.data[].operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyMethod | array<string> |
通知方法。一般的に mobile は電話、message は SMS、email はメールです。オブジェクトチャネルはオブジェクト設定に従って実行されます。 |
| content.data[].operateRecord.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": [
{
"id": 123,
"uuid": "incident_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "支付服务异常",
"level": "system_level_1",
"description": "部分请求失败",
"source": "external",
"resourceCategory": "",
"resourceType": "",
"resourceUUID": "",
"resourceUrl": "https://example.com/runbook",
"eventRelations": [],
"resourceIdentity": "",
"assigner": [],
"incidentsStatus": "open",
"statusTime": {
"open": 1785427200
},
"statusChangeTime": 1785427200,
"cumulativeTime": 0,
"eventCount": 0,
"eventUpdateAt": 0,
"dimensionTag": {
"service": "payment"
},
"extend": {},
"dtHost": "",
"dtResource": "",
"dtPodName": "",
"dtAppName": "",
"dtAppId": "",
"dtEnv": "",
"dtUrl": "",
"dtService": "payment",
"assignerInfo": [],
"operateRecord": {
"operatorInfo": {}
},
"scheduleInfo": [],
"workspaceInfo": {
"uuid": "wksp_example",
"name": "生产空间"
},
"regionCode": "site_example",
"isExternalWorkspace": false
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反しています | パラメーター解析失敗 | パラメーターの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効です | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではありません | 一部の JSON ファイル形式エラー | オブジェクトを送信してください。 |
| 406 | ft.IncidentsFilterFieldNotSupported | filters.field がサポート対象の特殊フィールド/ディメンションまたはモデル列ではありません(例: project) | project フィールドによるインシデント一覧の照会は現在サポートされていません | 本文でサポートされているフィールドに変更してください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴オブジェクト/設定形式、または関連サマリー構築などの未処理例外 | 内部エラー | クエリパラメーターを確認し、traceId を保持してください。バックオフして再試行できます。継続的に失敗する場合は、管理者に関連する履歴記録とサービスログの確認を依頼してください。 |