コンテンツにスキップ

一覧取得



POST /api/v1/issue/list

概要

現在のワークスペースの Issue をページングして一覧取得します。チャンネル、作成時刻、ステータス、レベル、キーワードによる絞り込みをサポートします。

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

デフォルトでは作成時刻の降順で、pageIndex=1、pageSize=10 です。startTime/endTime は Unix 秒を使用し、両方に非ゼロ値を指定した場合のみ有効になります。イベント API のミリ秒時間パラメータとは区別してください。ページングはトップレベルの pageInfo.totalCount に従い、Issue 配列は content.data から読み取ります。pageInfo は content 内にはありません。データ更新中はページをまたぐ結果が変わる可能性があります。操作は現在の API Key が属するワークスペースを使用します。同一ワークスペースからリソース識別子を取得してください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報です。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

リクエスト Body パラメータ

パラメータ名 型 必須 説明
filters[*] json 単一のフィルターオブジェクトです。イベント API の name/operation 構造は使用しません。
例: {"key": "statusType", "value": 10, "equal": true}
取得または入力方法: 各条件に key、value、および boolean 型の equal を指定します。
filters[*].key json この API の絞り込みには次のキーのみ使用できます。
例: statusType
取得または入力方法: 絞り込み対象に応じて level、statusType、resource、creator、updator を選択します。
filters[*].value json 単一の絞り込み値です。ステータスは整数、それ以外は文字列を使用します。
例: 10
取得または入力方法: level にはレベルの UUID、statusType には 10/15/20/25/30、resource にはソース値または現在の言語での表示名、creator/updator にはアカウント UUID またはメンバー名を指定します。SYS も使用できます。
filters[*].equal json 比較方式です。明示的に指定することを推奨します。省略した場合は「等しくない」分岐として処理されます。
例: true
取得または入力方法: ブール値の true は等しい、false は等しくないを意味します。文字列の「false」は使用しないでください。
channelUUID string 任意の単一チャンネル絞り込みです。このチャンネルに紐づく Issue を返します。
null 許可: False
例: chan_example
取得または入力方法: チャンネル一覧 の content[].uuid から取得します。省略した場合は現在のワークスペースの全チャンネルの Issue を検索します。
endTime integer 作成時刻の上限です。Unix 秒で、startTime とともに閉区間を構成します。
null 許可: False
例: 1785430800
取得または入力方法: クライアントの時間ウィジェットで終了時刻を Unix 秒として取得します。startTime と一緒に指定する必要があります。
filters array Issue フィールドの絞り込みです。同じフィールドの複数の「等しい」条件は OR で結合され、複数の「等しくない」条件および「等しい/等しくない」が混在する条件は AND で結合されます。異なるフィールド間は AND です。
null 許可: False
例: [{"key": "statusType", "value": 10, "equal": true}]
取得または入力方法: Issue 詳細、有効レベル一覧、またはこのワークスペースのメンバー管理から絞り込み値を取得します。省略または [] の場合はこれらの条件を追加しません。
pageIndex integer ページ番号です。デフォルトは 1 です。正の整数を使用してください。
null 許可: False
例: 1
取得または入力方法: 最初のページは 1 を指定し、以降は増加させます。絞り込み条件は一貫させてください。
pageSize integer 1 ページあたりの件数です。デフォルトは 10 です。0 や負の数は指定しないでください。
null 許可: False
例: 10
取得または入力方法: 必要な正の整数を指定します。レスポンスサイズを抑えるため、適切な件数を使用することを推奨します。
search string タイトルと説明に対する部分一致検索です。
空文字列の許可: True
null 許可: False
例: checkout
取得または入力方法: タイトルまたは説明の一部テキストを指定します。省略または空文字列の場合は絞り込みません。
startTime integer 作成時刻の下限です。Unix 秒で指定します。両端が非ゼロ値の場合のみ時間フィルターが有効になります。
null 許可: False
例: 1785427200
取得または入力方法: クライアントで Issue の作成時刻を選択し、Unix 秒に変換します。endTime と一緒に指定する必要があります。

パラメータ補足

この API では manager、channelUUIDs、およびワークスペースをまたぐパラメータは宣言されていません。パラメータ表の公開フィールドを使用してください。filters のネストされたオブジェクトはフィールド単位で検証されないため、型が誤っていると内部エラーが発生する可能性があります。送信前に例に従って確認してください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/issue/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"filters":[{"key":"statusType","value":10,"equal":true}],"pageIndex":1,"pageSize":10}'

レスポンス

HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示しています。

フィールド 型 説明
content.data array<object> 現在のページの Issue 配列です。結果がない場合は [] です。
content.data[].id integer または null レコード番号です。Issue 作成/返信のレスポンスでは、永続化前に構築された場合に null になることがあります。リソースを操作する場合は uuid を使用してください。
content.data[].uuid string リソース UUID。
content.data[].workspaceUUID string 所属ワークスペースの UUID。
content.data[].status integer レコードステータスです。0 は正常、3 は削除済みです。Issue の業務ステータス statusType とは区別してください。
content.data[].creator string 作成時の呼び出し元識別子です。API Key の識別子、アカウント、またはシステム ID の場合があります。
content.data[].updator string 最終更新者の識別子です。未設定の場合は空文字列です。
content.data[].createAt integer 作成時刻(Unix 秒)。
content.data[].updateAt integer 最終更新時刻(Unix 秒)。未更新の場合は -1 になることがあります。
content.data[].deleteAt integer 削除時刻(Unix 秒)。未削除の場合は -1 です。
content.data[].name string Issue のタイトル。
content.data[].level string レベルの UUID です。空文字列は未指定を表し、レベル名ではありません。
content.data[].statusType integer ステータス: 10 Open、15 Working、20 Resolved、25 Closed、30 Pending。
content.data[].statusTypeUpdateRecord array<string> ステータス変更履歴です。各項目は Unix 秒&&ステータス名の形式です。
content.data[].statusTypeUpdateRecord[] string 1 件のステータス変更レコード。
content.data[].description string Issue の説明。
content.data[].resourceType string ソース種別です。event、dashboard、viewer などがあり、自動作成の場合は checker、keyeventAutoDiscovery などになることもあります。
content.data[].resourceUUID string 関連ソースの識別子です。具体的な意味はソース種別によって異なります。
content.data[].resource string ソースモジュールまたは名前です。例: LOG、TRACING、EVENTS、RUM。
content.data[].repeatType string 自動検出された問題の重複種別です。new、repeat、regression のいずれかで、手動作成の場合は空になることがあります。
content.data[].subIdentify string ソースで定義された関連サブ識別子です。手動作成の場合は通常空です。
content.data[].resolveAt integer 最後に Resolved または Closed に設定された時刻(Unix 秒)です。一度も復旧していない場合は -1 です。再オープンしてもこの履歴時刻は自動的にクリアされません。
content.data[].eventCount integer 記録された関連イベント数。
content.data[].eventCountUpdateAt integer 関連イベント数の最終更新時刻(Unix 秒)です。まだ記録されていない場合は -1 です。
content.data[].triggerRecord object 過去互換性のためのフィールドです。現在は通知トリガーの制御パラメータとしては使用されません。
content.data[].extend object 拡張内容です。リクエストではオブジェクト {} を渡し、null は渡さないでください。メンバー、チャンネル、担当者などの構造についてはパラメータ表を参照してください。
content.data[].extend.text string 長さチェック用のプレーンテキストです。最大 3000 文字です。
content.data[].extend.channels array<object> 説明内で参照されているチャンネルです。uuid、name、type、exists を含みます。返却時には exists が現在のリソース存在性に基づいて更新されます。
content.data[].extend.channels[].uuid string チャンネル UUID。
content.data[].extend.channels[].name string または null 表示名。
content.data[].extend.channels[].type string チャンネル参照マーカー #。
content.data[].extend.channels[].exists boolean 返却時にそのチャンネルが存在するかどうか。
content.data[].extend.members array<object> 説明内で @ されたメンバー参照です。uuid、name、type、exists を含みます。
content.data[].extend.members[].uuid string メンバーアカウントの UUID。
content.data[].extend.members[].name string または null 表示名。
content.data[].extend.members[].type string メンバー参照マーカー @。
content.data[].extend.members[].exists boolean 返却時にそのアカウントが存在するかどうか。
content.data[].extend.manager array<string> 担当者識別子の配列で、Issue でのみ使用されます。メンバー/チーム/通知先/メールなどは有効性に基づいて正規化されます。
content.data[].extend.manager[] string 単一の担当者識別子。
content.data[].extend.linkList array<object> 業務参考リンク。
content.data[].extend.linkList[].name string リンクの表示名。
content.data[].extend.linkList[].link string 業務 URL。
content.data[].extend.sourceLink string ソースページのリンクです。存在する場合はクライアントが入力します。
content.data[].extend.extra object サードパーティ連携の表示情報です。API の実際の認証 ID は変更しません。
content.data[].extend.extra.creator object サードパーティの作成者の表示情報です。name、email を含む場合があります。
content.data[].extend.extra.creator.name string 作成者の表示名。
content.data[].extend.extra.creator.email string 作成者の表示メールアドレス。
content.data[].extend.extra.updator object サードパーティの更新者の表示情報です。name、email を含む場合があります。
content.data[].extend.extra.updator.name string 更新者の表示名。
content.data[].extend.extra.updator.email string 更新者の表示メールアドレス。
content.data[].extend.extra.managerInfos object 担当者のメールアドレスをキーとする表示情報のマッピングで、Issue でのみ使用されます。
content.data[].extend.extra.managerInfos.邮箱.name string 該当するメールアドレスの担当者の表示名。
content.data[].extend.其他字段 JSON クライアントが保存するその他の拡張情報です。すべてが業務動作をトリガーするわけではありません。
content.data[].creatorInfo object 作成者の表示情報です。サードパーティの extend.extra.creator に値がある場合、一部の読み取り API ではこの表示情報が優先して使用されます。
content.data[].creatorInfo.name string 表示名。省略可能です。
content.data[].creatorInfo.email string メールアドレス。省略可能です。
content.data[].creatorInfo.uuid string アカウント UUID。省略可能です。
content.data[].updatorInfo object 更新者の表示情報です。空のオブジェクトの場合があります。
content.data[].updatorInfo.name string 表示名。省略可能です。
content.data[].updatorInfo.email string メールアドレス。省略可能です。
content.data[].updatorInfo.uuid string アカウント UUID。省略可能です。
content.data[].levelInfo object 履歴レベルの表示情報です。削除済み、または現在の有効一覧に存在しない旧レベルが含まれる場合があります。対応する設定がない場合は {} になることがあります。新規書き込みに使用できるかどうかは有効レベル一覧に従います。
content.data[].levelInfo.uuid string レベルの UUID です。Issue.level に引き続き使用できるかどうかは、現在の有効レベル一覧に基づいて判断してください。
content.data[].levelInfo.name string レベル名です。ワークスペースの言語またはレベル設定に応じて表示されます。
content.data[].levelInfo.color string 色文字列です。通常は #RRGGBB です。
content.data[].levelInfo.description string レベルの説明。
content.data[].managerInfos array<object> 解析済みの担当者表示情報です。アカウント情報は実際に表示可能なフィールドに応じて返され、チーム/通知先は通常 uuid と name を含み、メールは uuid/email/name を含みます。
content.data[].managerInfos[].uuid string 担当者識別子。
content.data[].managerInfos[].name string 表示名。
content.data[].managerInfos[].email string 担当者のメールアドレスまたはアカウントのメールアドレスです。値がある場合に提供されます。
content.data[].ruleType string ソースが checker で、モニター設定が取得できた場合に提供される種別です。
content.data[].eventTimeRange array<integer> 関連イベント数が存在する場合に提供される開始・終了時刻(Unix ミリ秒)。
content.data[].eventTimeRange[] integer Unix ミリ秒のタイムスタンプ。
content.data[].eventConditions string 自動検出ソースに有効なルールが存在する場合に提供されるイベント検索条件。
content.data[].eventConditionsFilters JSON 自動検出ソースの絞り込み編集データです。設定がある場合に提供されます。
content.data[].channels array<object> channelUUID を指定して絞り込んだ場合に、一致するチャンネルオブジェクトを補足します。各項目は uuid/name を含みます。
content.data[].channels[].uuid string チャンネル UUID。
content.data[].channels[].name string チャンネル名。
content.declaration object または null ワークスペースの共通宣言です。content のこの階層にのみ付加されます。
pageInfo object トップレベルのページング情報。
pageInfo.pageIndex integer 現在のページ番号。
pageInfo.pageSize integer このページの最大件数。
pageInfo.count integer このページの実際の件数。
pageInfo.totalCount integer 条件に一致する総件数。
content.data[].creatorInfo.status integer アカウントレコードのステータス。省略可能です。
content.data[].creatorInfo.wsAccountStatus integer 現在のワークスペースにおけるアカウントステータス。省略可能です。
content.data[].creatorInfo.username string ログイン名。省略可能です。
content.data[].creatorInfo.iconUrl string アカウントのアバター URL。省略可能です。
content.data[].creatorInfo.mobile string アカウントの携帯電話番号。空または省略の場合があります。
content.data[].creatorInfo.countryCode string 携帯電話番号の国/地域コード。省略可能です。
content.data[].creatorInfo.acntWsNickname string ワークスペースのニックネーム。省略可能です。
content.data[].updatorInfo.status integer アカウントレコードのステータス。省略可能です。
content.data[].updatorInfo.wsAccountStatus integer 現在のワークスペースにおけるアカウントステータス。省略可能です。
content.data[].updatorInfo.username string ログイン名。省略可能です。
content.data[].updatorInfo.iconUrl string アカウントのアバター URL。省略可能です。
content.data[].updatorInfo.mobile string アカウントの携帯電話番号。空または省略の場合があります。
content.data[].updatorInfo.countryCode string 携帯電話番号の国/地域コード。省略可能です。
content.data[].updatorInfo.acntWsNickname string ワークスペースのニックネーム。省略可能です。
content.data[].managerInfos[].status integer アカウントレコードのステータス。省略可能です。
content.data[].managerInfos[].wsAccountStatus integer 現在のワークスペースにおけるアカウントステータス。省略可能です。
content.data[].managerInfos[].username string ログイン名。省略可能です。
content.data[].managerInfos[].iconUrl string アカウントのアバター URL。省略可能です。
content.data[].managerInfos[].mobile string アカウントの携帯電話番号。空または省略の場合があります。
content.data[].managerInfos[].countryCode string 携帯電話番号の国/地域コード。省略可能です。
content.data[].managerInfos[].acntWsNickname string ワークスペースのニックネーム。省略可能です。
content.data[].managerInfos[].id integer 一覧取得の経路では、アカウント担当者にアカウントレコード番号が付く場合があります。
content.data[].managerInfos[].source string 一覧取得の経路におけるアカウントのソース。省略可能です。
content.data[].managerInfos[].userIconUrl string 一覧取得の経路におけるアカウントのアバター URL。省略可能です。
content.data[].managerInfos[].exterId string アカウントの外部識別子。省略可能です。
content.data[].managerInfos[].namespace string アカウントが属する名前空間。省略可能です。
content.data[].managerInfos[].attributes object または array ソースアカウントの属性。省略可能です。キーと構造は ID ソースによって定義されます。
content.data[].managerInfos[].attributes.自定义字段 JSON ソースで定義されたアカウント属性。
content.data[].managerInfos[].customAttributes object または array カスタムアカウント属性。省略可能です。
content.data[].managerInfos[].customAttributes.自定义字段 JSON カスタムアカウント属性値。
content.data[].managerInfos[].defaultWebhook object 一部のエージェントアカウントが提供するデフォルト Webhook の説明です。省略可能です。構造はアカウント設定によって異なります。
content.data[].managerInfos[].defaultWebhook.自定义字段 JSON Webhook 設定内でソースに応じて提供されるフィールド。
content.data[].levelInfo.id integer または null レベルのレコード番号です。システムデフォルトレベルではこのフィールドは提供されません。
content.data[].levelInfo.workspaceUUID string 履歴レベルの表示情報における任意フィールド。所属ワークスペースの UUID。
content.data[].levelInfo.status integer 履歴レベルの表示情報における任意フィールド。レコードステータスです。0 は正常、3 は削除済みです。Issue の業務ステータス statusType とは区別してください。
content.data[].levelInfo.creator string 履歴レベルの表示情報における任意フィールド。作成時の呼び出し元識別子です。API Key の識別子、アカウント、またはシステム ID の場合があります。
content.data[].levelInfo.updator string 履歴レベルの表示情報における任意フィールド。最終更新者の識別子です。未設定の場合は空文字列です。
content.data[].levelInfo.createAt integer 履歴レベルの表示情報における任意フィールド。作成時刻(Unix 秒)。
content.data[].levelInfo.updateAt integer 履歴レベルの表示情報における任意フィールド。最終更新時刻(Unix 秒)。未更新の場合は -1 になることがあります。
content.data[].levelInfo.deleteAt integer 履歴レベルの表示情報における任意フィールド。削除時刻(Unix 秒)。未削除の場合は -1 です。
content.data[].levelInfo.extend object または null 履歴レベルの表示情報における任意フィールド。作成時に保存された追加 JSON オブジェクトです。現在、レベル変更 API ではこのフィールドは変更されません。
content.data[].levelInfo.isManage boolean または number 履歴レベルの表示情報における任意フィールド。プラットフォーム管理レベルかどうかです。ワークスペースで作成したものは通常 false です。
content.data[].levelInfo.isDefault boolean システムデフォルトレベルの表示フラグ。省略可能です。
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 101,
        "uuid": "issue_example",
        "workspaceUUID": "wksp_example",
        "status": 0,
        "creator": "wsak_example",
        "updator": "wsak_example",
        "createAt": 1785430800,
        "updateAt": 1785430800,
        "deleteAt": -1,
        "name": "checkout-api 延迟异常",
        "level": "system_level_1",
        "statusType": 10,
        "statusTypeUpdateRecord": [],
        "description": "定位生产接口延迟,记录处理过程。",
        "resourceType": "",
        "resourceUUID": "",
        "resource": "",
        "repeatType": "",
        "subIdentify": "",
        "extend": {},
        "resolveAt": -1,
        "eventCount": 0,
        "eventCountUpdateAt": -1,
        "triggerRecord": {},
        "creatorInfo": {},
        "updatorInfo": {},
        "levelInfo": {
          "uuid": "system_level_1",
          "name": "P1",
          "description": "业务重要功能不可用,但影响用户有限。",
          "color": "#FF7931",
          "isDefault": true
        },
        "managerInfos": []
      }
    ],
    "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 ファイルの形式エラーです JSON オブジェクトを送信してください。
500 ft.InternalServerError レベルの保存、設定の保存、監査、またはその他の内部処理に失敗しました 内部エラーです まず現在のレベルまたは設定を読み取って結果を確認し、その後リトライを判断してください。失敗が続く場合は traceId を提供してください。

フィードバック

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