取得¶
GET /api/v1/incidents/{incident_uuid}/get
概要¶
インシデント詳細、関連サマリー、ライフサイクル統計を取得します。
呼び出し前の準備と使用手順¶
Key は routine.defaultAccess または incidents.incidentsQuery のいずれかに一致する必要があります。現在の API Key が属するワークスペースのみを対象とします。本モジュールのインシデント UUID はインシデント一覧の content.data[].uuid から取得し、通常は incident_ プレフィックスです。公開エンドポイントは workspaceUUID/workspaceUUIDs を受け付けないため、フロントエンド/内部インターフェースのワークスペース間パラメータをそのまま流用しないでください。
現在のワークスペースの未削除インシデントのみを読み取り、ソースの完全な resourceContent、添付ファイル、担当者、マッチしたオンコール設定、最新操作、今回のラウンドのエスカレーション記録、metrics を返します。元の添付ファイル内容を返したり、通知が配信済みであることを保証したりするものではありません。詳細の scheduleInfo はマッチした設定であり、これに基づいて特定のメンバーが現時点でオンコール中であると判定することはできません。タグとディメンションの両方が設定されている場合は、いずれかにマッチすれば含めます。詳細のタグのみのマッチングではすべてのタグを満たす必要があり、一覧のタグのみの互換マッチングでいずれかがヒットするのとは異なります。
ビジネス上の incidentsStatus とデータベースの status、累計継続秒数 cumulativeTime と metrics.currentCycle.durationSeconds は意味が異なります。metrics は操作履歴に基づいて再構築され、古い履歴が不足している場合は null を返すことがあるため、null を 0 として扱わないでください。レスポンスには専用の tagInfo リストは提供されません。タグの関連付けは、書き込みレスポンスまたはタグ管理で確認してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/incidents/incident_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | データベース行 ID。業務上の特定には uuid を使用し、コミット前のスナップショットでは null の場合があります。 |
| content.uuid | string | このリソースの UUID。 |
| content.status | integer | データベースステータス。0 はアクティブ、3 は削除。インシデントのビジネスステータス incidentsStatus とは異なります。 |
| content.creator | string | 作成主体。API Key の場合は通常 wsak_ にリソースUUID を続けた形式です。 |
| content.updator | string | 最新更新主体。未更新の場合は空の場合があります。 |
| content.createAt | integer | Unix 秒の作成時刻。 |
| content.updateAt | integer | Unix 秒の最終更新時刻。 |
| content.deleteAt | integer | Unix 秒の削除時刻。未削除の場合は -1。 |
| content.workspaceUUID | string | インシデントが属するワークスペース。 |
| content.name | string | インシデント名。 |
| content.level | string | インシデントレベル UUID。system_level_0 など、または issl_/isslm_ の履歴識別子。レベルの表示名とは異なります。 |
| content.description | string または null | インシデントの説明。 |
| content.source | string | インシデントのソース。本公開エンドポイントからの手動作成では現在 external であり、External API 認証を使用していることを示すものではありません。 |
| content.resourceCategory | string | ソースリソースカテゴリ。自動インシデントではソースに応じて設定され、公開エンドポイントからの手動作成では通常空です。 |
| content.resourceType | string | ソースリソースタイプ。集約インシデントでは incident_aggregation、手動作成では通常空です。 |
| content.resourceUUID | string | ソースリソース UUID。手動作成では通常空です。 |
| content.resourceUrl | string | 保存されたソース URL。レスポンスフィールドでは l が小文字であり、リクエストの resourceURL と区別します。 |
| content.resourceContent | object または JSON | ソースの元の内容。型はモニター/イベント/集約ソースによって変化します。一覧ではこのフィールドは削除されます。 |
| content.eventRelations | array<object> |
現在のインシデントライフサイクルに関連するイベントスナップショット。再度オープンして新しいラウンドになるとクリアされる場合があります。 |
| content.eventRelations[] | object | ソースイベントの関連付け記述。イベントタイプに応じて動的フィールドを返します。本インターフェースでインシデントを作成する際に設定できるオブジェクトではありません。 |
| content.eventRelations[].カスタムフィールド | JSON | イベント生成側が保存した関連キーと値。まず実際の型に従って読み取ります。 |
| content.resourceIdentity | string | ソースの集約/子識別子。手動作成では空の場合があります。 |
| content.assigner | array<string> |
担当者識別子のリスト。acnt_/group_/notify_ を含む場合があります。すべての識別子が有効であることを保証するものではありません。 |
| content.assigner[] | string | 保存された担当者/グループ/通知先識別子の 1 つ。 |
| content.incidentsStatus | string | ビジネスステータス open/working/resolved/closed。 |
| content.statusTime | object | 現在のライフサイクルで記録済みのステータス時刻(Unix 秒)。すべてのステータスが存在するわけではありません。 |
| content.statusTime.open | integer | 今回のラウンドのオープン時刻。 |
| content.statusTime.working | integer | 今回のラウンドで処理を開始した時刻。省略される場合があります。 |
| content.statusTime.resolved | integer | 今回のラウンドの復旧時刻。省略される場合があります。 |
| content.statusTime.closed | integer | 今回のラウンドのクローズ時刻。省略される場合があります。 |
| content.statusChangeTime | integer | 現在のライフサイクルのトリガー時刻。再オープン時に更新されます。各フィールドの変更時刻とは異なります。 |
| content.cumulativeTime | integer | インシデントの累計継続秒数。詳細/一覧では現在のステータスを組み合わせてリアルタイムに計算されます。書き込みレスポンスでは保存値となる場合があります。 |
| content.eventCount | integer | 関連イベント数。手動作成では通常 0 です。 |
| content.eventUpdateAt | integer | ソースの最新イベント更新時刻(Unix 秒)。手動作成では通常 0 です。 |
| content.dimensionTag | object | ディメンション名から値への JSON マッピング。 |
| content.dimensionTag.カスタムキー | JSON | 呼び出し元またはソースが保存したディメンション値。文字列を推奨します。host/service などには別途インデックスフィールドがあります。 |
| content.extend | object または JSON | インシデント拡張データ。自動ソースでは集約/イベントなどの設定が付随する場合があります。作成の公開エンドポイントでは現在、渡された extend を保存しません。変更時のみオブジェクト全体を置き換えられます。 |
| content.extend.linkList | array<object> |
ビジネスリンクの配列。保存後に表示用途で使用され、本インターフェースが外部 URL にアクセスするものではありません。 |
| content.extend.linkList[].name | string | リンクの表示名。 |
| content.extend.linkList[].link | string | リンクアドレス。 |
| content.extend.aggregationRuleUUID | string | 集約ソースルール UUID。存在する場合は filters.aggregationRuleUUID に使用できます。 |
| content.extend.カスタムフィールド | JSON | その他保存されたソース拡張フィールド。固定構造は保証されません。オブジェクト全体を置き換える前に、既存オブジェクト全体をコピーしてください。 |
| content.dtHost | string または null | host インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.dtService | string または null | service インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.dtResource | string または null | resource インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.dtPodName | string または null | pod_name インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.dtAppName | string または null | app_name インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.dtAppId | string または null | app_id インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.dtEnv | string または null | env インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.dtUrl | string または null | url インデックスディメンション。作成時の dimensionTag に由来します。現在、公開エンドポイントでの dimensionTag の変更は反映されません。 |
| content.eventRelations[].df_fault_id | string | イベントライフサイクル ID。イベントの df_fault_id または互換の df_status_fault_id から生成されます。インシデント UUID ではありません。 |
| content.eventRelations[].status | string | この関連イベントスナップショットの df_status ステータス(例: critical/ok)。インシデントの incidentsStatus とは異なります。 |
| content.eventRelations[].aggregationValues | object | 集約ルールによる関連付けの場合のみ存在する可能性があります。集約キーから対応するイベントディメンション値へのマッピングです。 |
| content.eventRelations[].aggregationValues.集約キー | JSON | 集約ルールで指定されたディメンションのイベント内の値。実際に保存された型に従って読み取ります。 |
| content.assignerInfo | array<object> |
実際に解決に成功した担当者のサマリー。アカウントは完全な識別情報フィールドを含み、グループ/通知先は uuid/name のみを含みます。未知の識別子は無視される場合があります。 |
| content.assignerInfo[].uuid | string | 主体 UUID。システム応答の主体は空またはシステム識別子の場合があります。 |
| content.assignerInfo[].status | integer | 主体ステータス。 |
| content.assignerInfo[].wsAccountStatus | integer | ワークスペースメンバーのステータス。Key の場合は Key のステータスであり、インシデントのステータスではありません。 |
| content.assignerInfo[].username | string | ログイン名/Key 名/システム名。 |
| content.assignerInfo[].name | string | 表示名。システム AI の表示名はサイト設定を使用します。 |
| content.assignerInfo[].iconUrl | string | アバター URL。システムサマリーでは省略される場合があります。 |
| content.assignerInfo[].email | string | 連絡先メールアドレス。Key サマリーの場合は Key UUID となることがあり、配信可能なメールアドレスではありません。 |
| content.assignerInfo[].mobile | string | 連絡先携帯電話番号。空の場合があります。 |
| content.assignerInfo[].countryCode | string | 国番号。システムサマリーでは省略される場合があります。 |
| content.assignerInfo[].acntWsNickname | string | ワークスペースのニックネーム。システムサマリーでは省略される場合があります。 |
| content.workspaceInfo | object | インシデントが属するワークスペースのサマリー。 |
| content.workspaceInfo.uuid | string | 所属ワークスペース UUID。 |
| content.workspaceInfo.name | string | ワークスペース名。解決できない場合は空になります。 |
| content.regionCode | string | 現在のサイトコード。 |
| content.isExternalWorkspace | boolean | 他のワークスペースに由来するかどうか。本 OpenAPI 公開エンドポイントはワークスペース間の対象を受け付けないため、通常は false です。 |
| content.aggregationRuleInfo | object または null | 集約インシデントにのみ付加され、有効なルールのサマリーまたは null です。 |
| content.aggregationRuleInfo.uuid | string | 集約ルール UUID。 |
| content.aggregationRuleInfo.name | string | 集約ルール名。 |
| content.aggregationRuleInfo.status | integer | ルールのデータベースステータス。 |
| content.scheduleInfo | array<object> |
現在マッチしたオンコール設定の元のサマリー。この時点で誰かがオンコール中であることや、通知が実際に配信済みであることを示すものではありません。詳細と一覧ではタグマッチングの互換ルールに差異があります。 |
| content.scheduleInfo[].id | integer または null | データベース行 ID。業務上の特定には uuid を使用し、コミット前のスナップショットでは null の場合があります。 |
| content.scheduleInfo[].uuid | string | このリソースの UUID。 |
| content.scheduleInfo[].status | integer | データベースステータス。0 はアクティブ、3 は削除。インシデントのビジネスステータス incidentsStatus とは異なります。 |
| content.scheduleInfo[].creator | string | 作成主体。API Key の場合は通常 wsak_ にリソースUUID を続けた形式です。 |
| content.scheduleInfo[].updator | string | 最新更新主体。未更新の場合は空の場合があります。 |
| content.scheduleInfo[].createAt | integer | Unix 秒の作成時刻。 |
| content.scheduleInfo[].updateAt | integer | Unix 秒の最終更新時刻。 |
| content.scheduleInfo[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は -1。 |
| content.scheduleInfo[].workspaceUUID | string | 所属ワークスペース。 |
| content.scheduleInfo[].name | string | オンコール名。 |
| content.scheduleInfo[].timezone | string | IANA タイムゾーン。 |
| content.scheduleInfo[].start | string | 互換の日次勤務開始時刻 HH:MM。スケジュールの timezone に従って解釈され、日付や Unix 時刻ではありません。 |
| content.scheduleInfo[].end | string | 互換の日次勤務終了時刻 HH:MM。有効日付の境界は別途 extend.effectiveTime を参照してください。 |
| content.scheduleInfo[].tagFilter | array<string> |
マッチング対象タグ UUID の配列。 |
| content.scheduleInfo[].tagFilter[] | string | タグ UUID。 |
| content.scheduleInfo[].dimensionFilter | string | ディメンションマッチングクエリ式。 |
| content.scheduleInfo[].notifyTargets | array<string> |
通知先識別子のリスト。 |
| content.scheduleInfo[].notifyTargets[] | string | アカウント/グループ/通知先などの対象識別子。 |
| content.scheduleInfo[].strategyConfig | array<object> |
エスカレーションポリシー設定。ワークスペースに保存されたバージョンに従って読み取ります。 |
| content.scheduleInfo[].strategyConfig[] | object | 1 件の設定ポリシー。インシデント読み取りインターフェースでは実行プレビューを展開しません。 |
| content.scheduleInfo[].strategyConfig[].カスタムフィールド | JSON | 保存されたポリシーレベル/待機/通知設定。完全なビジネス設定はオンコール管理で読み取ってください。 |
| content.scheduleInfo[].extend | object | シフト/ローテーションなどの拡張設定。 |
| content.scheduleInfo[].extend.カスタムフィールド | JSON | 保存されたオンコール拡張キーと値。本インターフェースでは変更できません。 |
| content.scheduleInfo[].isDefault | boolean | デフォルトのオンコールかどうか。 |
| content.scheduleInfo[].rotationUpdateAt | integer | ローテーション変更の Unix 秒時刻。履歴では -1 の場合があります。 |
| content.scheduleInfo[].agentUUIDs | array<string> |
拡張内の関連 Agent UUID 配列。 |
| content.scheduleInfo[].agentUUIDs[] | string | 1 つの Agent UUID。 |
| content.scheduleInfo[].strategyConfig[].uuid | string | ポリシー UUID。 |
| content.scheduleInfo[].strategyConfig[].name | string | ポリシー名。 |
| content.scheduleInfo[].strategyConfig[].strategy | array<object> |
このポリシーのエスカレーション階層設定の配列。 |
| content.scheduleInfo[].strategyConfig[].strategy[].level | integer | 階層番号。通常は 0 から始まります。 |
| content.scheduleInfo[].strategyConfig[].strategy[].levelUpTime | integer | インシデントステータスのトリガー時刻からのエスカレーション待機秒数。 |
| content.scheduleInfo[].strategyConfig[].strategy[].incidentsLevel | array<string> |
適用するインシデントレベル UUID のリスト。 |
| content.scheduleInfo[].strategyConfig[].strategy[].incidentsLevel[] | string | 1 つのレベル UUID。 |
| content.scheduleInfo[].strategyConfig[].strategy[].incidentsStatus | array<string> |
適用するインシデントステータスのリスト(例: open/working)。 |
| content.scheduleInfo[].strategyConfig[].strategy[].incidentsStatus[] | string | 1 つのインシデントステータス。 |
| content.scheduleInfo[].strategyConfig[].strategy[].ifRepeatNotify | boolean | 繰り返し通知するかどうか。 |
| content.scheduleInfo[].strategyConfig[].strategy[].repeatNotifyInterval | integer | 繰り返し通知の間隔秒。 |
| content.scheduleInfo[].strategyConfig[].strategy[].notifyConfig | array<object> |
この階層の通知設定の配列。 |
| content.scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObjectType | string | 通知先の分類(例: member/object/group)。保存されたバージョンに従って読み取ります。 |
| content.scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObject | array<string> |
通知先識別子。watchkeeper は実行時の現在のオンコール担当者を表し、固定のアカウント UUID ではありません。 |
| content.scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyObject[] | string | 1 つの対象アカウント/グループ/通知先識別子または watchkeeper。 |
| content.scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyMethod | array<string> |
通知方法。一般的に mobile は電話、message は SMS、email はメールです。オブジェクトチャネルはオブジェクト設定に従って実行されます。 |
| content.scheduleInfo[].strategyConfig[].strategy[].notifyConfig[].notifyMethod[] | string | 1 つの通知方法。 |
| content.scheduleInfo[].extend.enableRotateNotification | boolean | 通知先をローテーションするかどうか。 |
| content.scheduleInfo[].extend.rotationCycle | string | day/week/month/workDay/weekend/customDay/customWeek のいずれか。履歴では省略される場合があります。 |
| content.scheduleInfo[].extend.rotationInterval | integer | customDay のローテーション間隔日数は 1~31、customWeek の週数は 1~4 です。 |
| content.scheduleInfo[].extend.effectiveTime | object | スケジュール有効期間設定。 |
| content.scheduleInfo[].extend.effectiveTime.start | integer | 保存された有効開始 Unix 秒。省略時は開始制限を設定しません。 |
| content.scheduleInfo[].extend.effectiveTime.end | integer | 保存された有効終了 Unix 秒。省略時は終了制限を設定しません。 |
| content.scheduleInfo[].extend.workTime | object | 勤務時間設定。省略時は互換の start/end とローテーション周期から導出されます。 |
| content.scheduleInfo[].extend.workTime.mode | string | allDay は終日、specificTimes は指定時刻です。 |
| content.scheduleInfo[].extend.workTime.periods | array<object> |
指定勤務時間帯の配列。 |
| content.scheduleInfo[].extend.workTime.periods[].weekdays | array<integer> |
適用曜日。1 は月曜日、7 は日曜日です。 |
| content.scheduleInfo[].extend.workTime.periods[].weekdays[] | integer | 1~7 のいずれか。 |
| content.scheduleInfo[].extend.workTime.periods[].start | string | 現地日の開始 HH:MM。 |
| content.scheduleInfo[].extend.workTime.periods[].end | string | 現地日の終了 HH:MM。 |
| content.scheduleInfo[].extend.agentUUIDs | array<string> |
関連 Agent UUID。エンティティには別途トップレベルの agentUUIDs 投影があります。 |
| content.scheduleInfo[].extend.agentUUIDs[] | string | 1 つの Agent UUID。 |
| content.operateRecord | object | 最新の操作レコードのサマリー。レコードがない場合でも operatorInfo={} を持つことがあります。 |
| content.operateRecord.uuid | string | 操作レコード UUID。 |
| content.operateRecord.createAt | integer | レコードの Unix 秒時刻。 |
| content.operateRecord.incidentsUUID | string | 所属インシデント UUID。 |
| content.operateRecord.workspaceUUID | string | 所属ワークスペース。 |
| content.operateRecord.content | string | ローカライズされた操作説明。機械可読であることは保証されません。operateType/extend で判断してください。 |
| content.operateRecord.extend | object | 操作拡張。operateType に応じて変化します。 |
| content.operateRecord.extend.before | JSON | ステータス/レベル/担当者の変更前の値。操作タイプに応じて文字列または配列の場合があります。 |
| content.operateRecord.extend.after | JSON | ステータス/レベル/担当者の変更後の値。 |
| content.operateRecord.extend.source | string | 操作ソース。デフォルトの studio エントリではこのキーを含まない場合があります。 |
| content.operateRecord.extend.カスタムフィールド | JSON | エスカレーションポリシーなどのアクションが持つ拡張メタデータ。元の値を保持し、リクエストパラメータとしては使用しません。 |
| content.operateRecord.operator | string | 実際の操作者のアカウント/Key/システム識別子。 |
| content.operateRecord.operateType | string | create/status_update/level_update/assigner_update/notify_level_update など。クライアントは拡張に互換性を持たせる必要があります。 |
| content.operateRecord.operatorInfo | object | 主体サマリー。対応情報がない場合は {} です。 |
| content.operateRecord.operatorInfo.uuid | string | 主体 UUID。システム応答の主体は空またはシステム識別子の場合があります。 |
| content.operateRecord.operatorInfo.status | integer | 主体ステータス。 |
| content.operateRecord.operatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータス。Key の場合は Key のステータスであり、インシデントのステータスではありません。 |
| content.operateRecord.operatorInfo.username | string | ログイン名/Key 名/システム名。 |
| content.operateRecord.operatorInfo.name | string | 表示名。システム AI の表示名はサイト設定を使用します。 |
| content.operateRecord.operatorInfo.iconUrl | string | アバター URL。システムサマリーでは省略される場合があります。 |
| content.operateRecord.operatorInfo.email | string | 連絡先メールアドレス。Key サマリーの場合は Key UUID となることがあり、配信可能なメールアドレスではありません。 |
| content.operateRecord.operatorInfo.mobile | string | 連絡先携帯電話番号。空の場合があります。 |
| content.operateRecord.operatorInfo.countryCode | string | 国番号。システムサマリーでは省略される場合があります。 |
| content.operateRecord.operatorInfo.acntWsNickname | string | ワークスペースのニックネーム。システムサマリーでは省略される場合があります。 |
| content.operateRecord.extend.before_info | object または array | 変更前のレベルサマリーまたは担当者サマリーの配列。ステータス変更では通常 {} です。レベルの before 自体は表示名です。 |
| content.operateRecord.extend.after_info | object または array | 変更後のレベル/担当者サマリー。実際の operateType と型に従って読み取ります。 |
| content.operateRecord.extend.schedule_name | string | 通知エスカレーション操作におけるオンコール/ポリシー名のサマリー。 |
| content.operateRecord.extend.incidents_status | string | 通知エスカレーション時のインシデントビジネスステータス。 |
| content.operateRecord.extend.strategy_info | object | 通知エスカレーションポリシーのスナップショット。 |
| content.operateRecord.extend.strategy_info.name | string | 所属スケジュール名。 |
| content.operateRecord.extend.strategy_info.strategy | object | 今回選択された階層と通知設定のスナップショット。 |
| content.operateRecord.extend.notify_info | object | 通知先識別子からその時点の対象情報へのマッピング。アカウント/グループ/通知先で形状が異なります。 |
| content.operateRecord.extend.notify_info.通知先識別子 | object または string | その時点の対象の名前/メール/メンバーなどの情報。実際の型に従って読み取ります。正常に配信されたことを示すものではありません。 |
| content.operateRecord.extend.is_muted | boolean | インシデント通知のミュートに該当した場合に true。エスカレーション記録があっても実際には送信されていません。 |
| content.operateRecord.extend.mute_rule_info | object | 該当したミュートルールのサマリー。 |
| content.operateRecord.extend.mute_rule_info.uuid | string | ミュートルール UUID。 |
| content.operateRecord.extend.mute_rule_info.name | string | ミュートルール名。 |
| content.operateRecord.extend.muted_notify_info | object | 送信予定だったがミュートされた対象情報のマッピング。 |
| content.operateRecord.extend.muted_notify_info.通知先識別子 | object または string | ミュートされた対象情報。 |
| content.operateRecord.extend.strategy_info.strategy.level | integer | 階層番号。通常は 0 から始まります。 |
| content.operateRecord.extend.strategy_info.strategy.levelUpTime | integer | インシデントステータスのトリガー時刻からのエスカレーション待機秒数。 |
| content.operateRecord.extend.strategy_info.strategy.incidentsLevel | array<string> |
適用するインシデントレベル UUID のリスト。 |
| content.operateRecord.extend.strategy_info.strategy.incidentsLevel[] | string | 1 つのレベル UUID。 |
| content.operateRecord.extend.strategy_info.strategy.incidentsStatus | array<string> |
適用するインシデントステータスのリスト(例: open/working)。 |
| content.operateRecord.extend.strategy_info.strategy.incidentsStatus[] | string | 1 つのインシデントステータス。 |
| content.operateRecord.extend.strategy_info.strategy.ifRepeatNotify | boolean | 繰り返し通知するかどうか。 |
| content.operateRecord.extend.strategy_info.strategy.repeatNotifyInterval | integer | 繰り返し通知の間隔秒。 |
| content.operateRecord.extend.strategy_info.strategy.notifyConfig | array<object> |
この階層の通知設定の配列。 |
| content.operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObjectType | string | 通知先の分類(例: member/object/group)。保存されたバージョンに従って読み取ります。 |
| content.operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObject | array<string> |
通知先識別子。watchkeeper は実行時の現在のオンコール担当者を表し、固定のアカウント UUID ではありません。 |
| content.operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyObject[] | string | 1 つの対象アカウント/グループ/通知先識別子または watchkeeper。 |
| content.operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyMethod | array<string> |
通知方法。一般的に mobile は電話、message は SMS、email はメールです。オブジェクトチャネルはオブジェクト設定に従って実行されます。 |
| content.operateRecord.extend.strategy_info.strategy.notifyConfig[].notifyMethod[] | string | 1 つの通知方法。 |
| content.attachments | array<object> |
関連付け済み添付ファイルのサマリー。未関連付けの場合は [] です。 |
| content.attachments[].uuid | string | 添付ファイル UUID。本モジュールの downloadAttachment インターフェースでダウンロードします。 |
| content.attachments[].fileName | string | 元のファイル名。 |
| content.attachments[].fileSuffix | string | ファイル拡張子(ドットなし)。ファイル内容/直リンクは返しません。 |
| content.upgradeInfo | array<object> |
今回の open 以降の notify_level_update 操作レコード。実行待ちのエスカレーション計画とは異なります。 |
| content.upgradeInfo[].id | integer または null | データベース行 ID。業務上の特定には uuid を使用し、コミット前のスナップショットでは null の場合があります。 |
| content.upgradeInfo[].uuid | string | このリソースの UUID。 |
| content.upgradeInfo[].status | integer | データベースステータス。0 はアクティブ、3 は削除。インシデントのビジネスステータス incidentsStatus とは異なります。 |
| content.upgradeInfo[].creator | string | 作成主体。API Key の場合は通常 wsak_ にリソースUUID を続けた形式です。 |
| content.upgradeInfo[].updator | string | 最新更新主体。未更新の場合は空の場合があります。 |
| content.upgradeInfo[].createAt | integer | Unix 秒の作成時刻。 |
| content.upgradeInfo[].updateAt | integer | Unix 秒の最終更新時刻。 |
| content.upgradeInfo[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は -1。 |
| content.upgradeInfo[].incidentsUUID | string | 所属インシデント UUID。 |
| content.upgradeInfo[].workspaceUUID | string | 所属ワークスペース。 |
| content.upgradeInfo[].content | string | ローカライズされた操作説明。機械可読であることは保証されません。operateType/extend で判断してください。 |
| content.upgradeInfo[].extend | object | 操作拡張。operateType に応じて変化します。 |
| content.upgradeInfo[].extend.before | JSON | ステータス/レベル/担当者の変更前の値。操作タイプに応じて文字列または配列の場合があります。 |
| content.upgradeInfo[].extend.after | JSON | ステータス/レベル/担当者の変更後の値。 |
| content.upgradeInfo[].extend.source | string | 操作ソース。デフォルトの studio エントリではこのキーを含まない場合があります。 |
| content.upgradeInfo[].extend.カスタムフィールド | JSON | エスカレーションポリシーなどのアクションが持つ拡張メタデータ。元の値を保持し、リクエストパラメータとしては使用しません。 |
| content.upgradeInfo[].operator | string | 実際の操作者のアカウント/Key/システム識別子。 |
| content.upgradeInfo[].operateType | string | create/status_update/level_update/assigner_update/notify_level_update など。クライアントは拡張に互換性を持たせる必要があります。 |
| content.upgradeInfo[].extend.before_info | object または array | 変更前のレベルサマリーまたは担当者サマリーの配列。ステータス変更では通常 {} です。レベルの before 自体は表示名です。 |
| content.upgradeInfo[].extend.after_info | object または array | 変更後のレベル/担当者サマリー。実際の operateType と型に従って読み取ります。 |
| content.upgradeInfo[].extend.schedule_name | string | 通知エスカレーション操作におけるオンコール/ポリシー名のサマリー。 |
| content.upgradeInfo[].extend.incidents_status | string | 通知エスカレーション時のインシデントビジネスステータス。 |
| content.upgradeInfo[].extend.strategy_info | object | 通知エスカレーションポリシーのスナップショット。 |
| content.upgradeInfo[].extend.strategy_info.name | string | 所属スケジュール名。 |
| content.upgradeInfo[].extend.strategy_info.strategy | object | 今回選択された階層と通知設定のスナップショット。 |
| content.upgradeInfo[].extend.notify_info | object | 通知先識別子からその時点の対象情報へのマッピング。アカウント/グループ/通知先で形状が異なります。 |
| content.upgradeInfo[].extend.notify_info.通知先識別子 | object または string | その時点の対象の名前/メール/メンバーなどの情報。実際の型に従って読み取ります。正常に配信されたことを示すものではありません。 |
| content.upgradeInfo[].extend.is_muted | boolean | インシデント通知のミュートに該当した場合に true。エスカレーション記録があっても実際には送信されていません。 |
| content.upgradeInfo[].extend.mute_rule_info | object | 該当したミュートルールのサマリー。 |
| content.upgradeInfo[].extend.mute_rule_info.uuid | string | ミュートルール UUID。 |
| content.upgradeInfo[].extend.mute_rule_info.name | string | ミュートルール名。 |
| content.upgradeInfo[].extend.muted_notify_info | object | 送信予定だったがミュートされた対象情報のマッピング。 |
| content.upgradeInfo[].extend.muted_notify_info.通知先識別子 | object または string | ミュートされた対象情報。 |
| content.upgradeInfo[].extend.strategy_info.strategy.level | integer | 階層番号。通常は 0 から始まります。 |
| content.upgradeInfo[].extend.strategy_info.strategy.levelUpTime | integer | インシデントステータスのトリガー時刻からのエスカレーション待機秒数。 |
| content.upgradeInfo[].extend.strategy_info.strategy.incidentsLevel | array<string> |
適用するインシデントレベル UUID のリスト。 |
| content.upgradeInfo[].extend.strategy_info.strategy.incidentsLevel[] | string | 1 つのレベル UUID。 |
| content.upgradeInfo[].extend.strategy_info.strategy.incidentsStatus | array<string> |
適用するインシデントステータスのリスト(例: open/working)。 |
| content.upgradeInfo[].extend.strategy_info.strategy.incidentsStatus[] | string | 1 つのインシデントステータス。 |
| content.upgradeInfo[].extend.strategy_info.strategy.ifRepeatNotify | boolean | 繰り返し通知するかどうか。 |
| content.upgradeInfo[].extend.strategy_info.strategy.repeatNotifyInterval | integer | 繰り返し通知の間隔秒。 |
| content.upgradeInfo[].extend.strategy_info.strategy.notifyConfig | array<object> |
この階層の通知設定の配列。 |
| content.upgradeInfo[].extend.strategy_info.strategy.notifyConfig[].notifyObjectType | string | 通知先の分類(例: member/object/group)。保存されたバージョンに従って読み取ります。 |
| content.upgradeInfo[].extend.strategy_info.strategy.notifyConfig[].notifyObject | array<string> |
通知先識別子。watchkeeper は実行時の現在のオンコール担当者を表し、固定のアカウント UUID ではありません。 |
| content.upgradeInfo[].extend.strategy_info.strategy.notifyConfig[].notifyObject[] | string | 1 つの対象アカウント/グループ/通知先識別子または watchkeeper。 |
| content.upgradeInfo[].extend.strategy_info.strategy.notifyConfig[].notifyMethod | array<string> |
通知方法。一般的に mobile は電話、message は SMS、email はメールです。オブジェクトチャネルはオブジェクト設定に従って実行されます。 |
| content.upgradeInfo[].extend.strategy_info.strategy.notifyConfig[].notifyMethod[] | string | 1 つの通知方法。 |
| content.metrics | object | ライフサイクル操作レコードに基づいて再構築された現在のラウンドと全体の統計(秒単位)。 |
| content.metrics.currentCycle | object | 現在のラウンド。 |
| content.metrics.currentCycle.triggerAt | integer または null | 今回のラウンドのトリガー Unix 秒。 |
| content.metrics.currentCycle.durationSeconds | integer または null | 今回のラウンドの継続秒数。未復旧の場合はクエリ時点まで計算されます。 |
| content.metrics.currentCycle.firstAcknowledgeAt | integer または null | 今回のラウンドで最初に有効な担当者が確認した Unix 秒。 |
| content.metrics.currentCycle.mttaSeconds | integer または null | 今回のラウンドの初回確認所要秒数。まだ確認がない場合は null です。 |
| content.metrics.currentCycle.resolvedAt | integer または null | 今回のラウンドの復旧 Unix 秒。未復旧の場合は null です。 |
| content.metrics.currentCycle.mttrSeconds | integer または null | 今回のラウンドの復旧所要秒数。未復旧の場合は null です。 |
| content.metrics.total | object | ラウンド間の統計。 |
| content.metrics.total.firstTriggerAt | integer または null | 最も早いライフサイクルトリガー Unix 秒。 |
| content.metrics.total.latestTriggerAt | integer または null | 最新ラウンドのトリガー Unix 秒。 |
| content.metrics.total.reopenCount | integer | 再オープン回数。 |
| content.metrics.total.avgMTTASeconds | integer または null | 有効な確認データがあるラウンドの平均確認秒数。整数で切り捨て。サンプルがない場合は null です。 |
| content.metrics.total.avgMTTRSeconds | integer または null | 復旧済みラウンドの平均復旧秒数。整数で切り捨て。サンプルがない場合は null です。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"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",
"resourceContent": {},
"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": [],
"attachments": [],
"upgradeInfo": [],
"operateRecord": {
"operatorInfo": {}
},
"scheduleInfo": [],
"workspaceInfo": {
"uuid": "wksp_example",
"name": "本番ワークスペース"
},
"regionCode": "site_example",
"isExternalWorkspace": false,
"metrics": {
"currentCycle": {
"triggerAt": 1785427200,
"durationSeconds": 60,
"firstAcknowledgeAt": null,
"mttaSeconds": null,
"resolvedAt": null,
"mttrSeconds": null
},
"total": {
"firstTriggerAt": 1785427200,
"latestTriggerAt": 1785427200,
"reopenCount": 0,
"avgMTTASeconds": null,
"avgMTTRSeconds": null
}
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 400 | ft.IncidentsNotFound | 対象のインシデントが現在のワークスペースに存在しないか、削除済みです | 指定されたインシデントが見つかりません | インシデント一覧から content.data[].uuid を再取得してください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴オブジェクト/設定形式、または関連サマリー構築などの未処理例外 | 内部エラー | クエリパラメータを確認し、traceId を保持してください。バックオフして再試行できます。継続的に失敗する場合は、管理者に関連する履歴レコードとサービスログの確認を依頼してください。 |