コンテンツにスキップ

インシデントコメント クエリ



GET /api/v1/incidents/comment/{incident_uuid}/list

概要

インシデントコメントおよび添付ファイル/アイデンティティ概要をページングで読み取ります。

呼び出し前の準備と使用手順

Key は routine.defaultAccess または incidents.incidentsQuery のいずれかに一致する必要があります。現在のワークスペースを読み取ります。パス incident_uuid はインシデント一覧の content.data[].uuid から取得します。createAt の降順、同一の場合は id の降順でページングします。既定値は pageIndex=1/pageSize=10 です。ページング情報はトップレベルの pageInfo にあり、content は data 配列および declaration を含むオブジェクトです。空のリストはインシデントの存在を証明するものではなく、このエンドポイントは親インシデントを事前に検証しません。

人手によるコメントおよびシステムコメントを返し、creatorInfo/updatorInfo と添付ファイルの概要を付加します。システム生成の操作コメントの creator は、システム応答のアイデンティティである場合があります。実際の操作主体は extend.operator/operator_info に含まれる場合があります。すべてのコメントを人手によるコメントとして扱わないでください。未知のアイデンティティは {} です。空の本文/拡張は保存された値のまま読み取り、添付ファイルは downloadAttachment で個別にダウンロードします。クエリ期間中に追加されたレコードはオフセットページングを移動させるため、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/comment/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[].comment string コメント本文。システム生成の操作説明を含む場合があります。本文を構造化された操作レコードとして扱わないでください。
content.data[].extend object または JSON 保存された拡張。システムコメントには operator/operator_info/operate_type/before/after などが含まれる場合があります。
content.data[].extend.members array<object> メンバー入力レコード。コメント作成時の追加メール通知候補に使用され、配信済みを意味しません。
content.data[].extend.members[].type string 「@」はアカウントへのメンションを示し、それ以外の値はこのメール通知候補には入りません。
content.data[].extend.members[].uuid string アカウント UUID。
content.data[].extend.members[].exists boolean クライアントエディタの状態。サーバー側の通知フィルタリングはこの値に依存しません。
content.data[].extend.linkList array<object> 業務リンクの表示情報。
content.data[].extend.linkList[].name string リンクの表示名。
content.data[].extend.linkList[].link string リンク URL。
content.data[].extend.manager array<string> 過去の外部担当者メールアドレスの配列。変更時に旧 extra.managerInfos を保持する場合のフィルタリングに使用され、インシデントの assigner とは異なります。
content.data[].extend.manager[] string 過去の担当者メールアドレス 1 件。
content.data[].extend.extra object 外部アイデンティティの補助情報。変更時に元の creator と、manager に残っている managerInfos が保持される場合があります。
content.data[].extend.extra.creator JSON 元の作成者の補助アイデンティティ情報。旧値が存在する場合、変更時にこれを使って作成者を書き換えることはできません。
content.data[].extend.extra.managerInfos object 過去の担当者メールアドレスからアイデンティティ情報への動的マッピング。
content.data[].extend.extra.managerInfos.邮箱 JSON そのメールアドレスに対応する元のアイデンティティ情報。
content.data[].extend.operator string システム操作コメントの元の操作主体識別子。
content.data[].extend.operator_info object システム操作コメントに付随する主体の概要。
content.data[].extend.operate_type string システム操作コメントに付随する操作タイプ。
content.data[].extend.before JSON システム操作の旧値。アクションに応じて変化します。
content.data[].extend.after JSON システム操作の新値。アクションに応じて変化します。
content.data[].extend.自定义字段 JSON 呼び出し元/システムが保存したその他の拡張キーと値。本インターフェースは固定構造を保証しません。
content.data[].extend.operator_info.uuid string 主体 UUID。システム応答主体は空またはシステム識別子の場合があります。
content.data[].extend.operator_info.status integer 主体の状態。
content.data[].extend.operator_info.wsAccountStatus integer ワークスペースメンバーの状態。Key の場合は Key の状態であり、インシデントの状態ではありません。
content.data[].extend.operator_info.username string ログイン名/Key 名/システム名。
content.data[].extend.operator_info.name string 表示名。システム AI の表示名はサイト設定を使用します。
content.data[].extend.operator_info.iconUrl string アバター URL。システム概要では省略される場合があります。
content.data[].extend.operator_info.email string 連絡先メールアドレス。Key 概要では Key UUID となる場合があり、配信可能なメールアドレスではありません。
content.data[].extend.operator_info.mobile string 連絡先電話番号。空になる場合があります。
content.data[].extend.operator_info.countryCode string 国番号。システム概要では省略される場合があります。
content.data[].extend.operator_info.acntWsNickname string ワークスペースのニックネーム。システム概要では省略される場合があります。
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[].attachments array<object> 関連付け済み添付ファイルの概要。未関連付けの場合は []。
content.data[].attachments[].uuid string 添付ファイル UUID。本モジュールの downloadAttachment インターフェースでダウンロードします。
content.data[].attachments[].fileName string 元のファイル名。
content.data[].attachments[].fileSuffix string ファイル拡張子(ドットなし)。ファイル内容/直リンクは返しません。
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": "inccmt_example",
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "incidentsUUID": "incident_example",
        "workspaceUUID": "wksp_example",
        "comment": "データベース接続の異常を確認済みです。対応中です。",
        "extend": {},
        "creatorInfo": {},
        "updatorInfo": {},
        "attachments": []
      }
    ],
    "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 を保持してください。バックオフして再試行できます。失敗が続く場合は、管理者に関連する履歴レコードとサービスログの確認を依頼してください。

フィードバック

このページは役に立ちましたか?