コンテンツにスキップ

取得



GET /api/v1/dashboards/list

概要

現在の呼び出し元が読み取り可能なダッシュボードをページ単位で一覧表示します。

呼び出し前と使用手順

名前とタグでフィルタリングできます。デフォルトでは、現在の呼び出し元のお気に入りを先に返し、残りの項目を更新日時の降順で並べます。更新日時がないレコードは作成日時を使用します。レスポンス項目の uuid を使用して、詳細取得、変更、エクスポート、または削除を呼び出します。空ページは data.length が 0 であることをもって走査を終了できます。

リクエストヘッダー

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

Query リクエストパラメータ

パラメータ名 型 必須 説明
search string ダッシュボード名の部分一致で検索します。省略または空白の場合、名前によるフィルタリングは行いません。
null を許可: False
例: 巡检
取得または入力方法: 既存のダッシュボード名からキーワードをコピーします。
tagNames json タグ名の JSON 配列文字列。複数の名前を指定した場合は、いずれかに一致するものを返します。
null を許可: False
例: ["team:ops"]
取得または入力方法: ダッシュボード詳細 の content.tagInfo[].name から値を取得し、JSON 文字列配列を構成して URL エンコードします。
pageIndex integer ページ番号。デフォルトは 1。
null を許可: False
$minValue: 1
例: 1
取得または入力方法: 1 から順に増やします。
pageSize integer 1 ページあたりのレコード数。デフォルトは 50、範囲は 1 から 100 です。
null を許可: False
$minValue: 1
$maxValue: 100
例: 20
取得または入力方法: 呼び出しの必要に応じて 1 ページあたりの件数を入力します。

パラメータの補足説明

tagNames は URL エンコードされた JSON 文字列配列を受け付けます。ページネーションオブジェクトはレスポンスのトップレベルにあります。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/dashboards/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=巡检' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=20

レスポンス

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

フィールド 型 説明
content.data array<object> 現在のページで条件に一致し、表示可能なダッシュボード。
content.data[].id integer ダッシュボードのレコード番号。
content.data[].uuid string ダッシュボード UUID。詳細取得、変更、削除、カルーセルに使用します。
content.data[].workspaceUUID string 所属ワークスペース。
content.data[].name string ダッシュボードの表示名。
content.data[].desc string ダッシュボードの説明。
content.data[].identifier string 外部向けのカスタム識別子。空の場合があります。
content.data[].ownerType string リソースタイプの帰属。ダッシュボードは通常 node です。
content.data[].type string ダッシュボードのタイプ。例: CUSTOM。
content.data[].chartPos array<object> グラフのレイアウト配列。各項目の chartUUID はグラフ識別子、pos はレイアウトオブジェクトです。
content.data[].chartPos[].chartUUID string 関連付けられたグラフ UUID。
content.data[].chartPos[].pos object グラフのサイズと位置。例: x、y、w、h。
content.data[].chartGroupPos array<string> グラフグループ識別子の並び順。
content.data[].iconSet object アイコン設定。
content.data[].isPublic integer 1 は公開、0 は作成した識別情報のみ表示、-1 はカスタム権限。
content.data[].extend object 拡張設定。
content.data[].mapping array<object> 変数フィールドのマッピング。
content.data[].createdWay string リソースの作成元。
content.data[].dashboardBindSet array ビューのバインド設定。
content.data[].openPermissionSet boolean 現在カスタム権限が有効かどうか。
content.data[].permissionSet array<string> 操作権限の主体 UUID リスト。
content.data[].readPermissionSet array<string> 読み取り権限の主体 UUID リスト。
content.data[].tagInfo array<object> このレスポンスに関連するタグ情報。
content.data[].tagInfo[].id string タグ識別子。uuid と同じです。
content.data[].tagInfo[].uuid string タグ UUID。
content.data[].tagInfo[].name string 関連付けられたタグ名。
content.data[].tagInfo[].description string タグの説明。
content.data[].tagInfo[].colour string タグの色。
content.data[].tagInfo[].scope array<string> タグの適用範囲。
content.data[].tagInfo[].tagPermissionInfo object タグ権限が設定されている場合に付随する操作権限と読み取り権限の情報。
content.data[].status integer レコードのステータス。
content.data[].creator string 作成者のアイデンティティ ID。
content.data[].updator string 最終更新者のアイデンティティ ID。更新がない場合は空になることがあります。
content.data[].createAt number 作成日時。Unix 秒。
content.data[].updateAt number 最終更新日時。Unix 秒。更新がない場合は -1 になることがあります。
content.data[].deleteAt number 削除日時。Unix 秒。未削除の場合は -1。
content.data[].creatorInfo object 作成者情報。空のオブジェクトの場合があります。
content.data[].updatorInfo object 最終更新者情報。空のオブジェクトの場合があります。
content.data[].isFavorite boolean 現在の呼び出し元がお気に入りに登録しているかどうか。詳細結果では通常、お気に入り登録時のみ表示されます。
content.data[].isIndexDashboard boolean 現在のワークスペースのホームダッシュボードかどうか。
content.data[].refCheckerUUIDs array<string> 参照しているモニター UUID。
content.data[].allow_operation boolean または null 権限計算後の操作ヒント。存在する場合は編集可能かどうかの判断に使用します。
content.data[].permissionSetInfo object 操作権限リストが設定されている場合、UUID ごとに主体の詳細を返します。
content.data[].readPermissionSetInfo object 読み取り権限リストが設定されている場合、UUID ごとに主体の詳細を返します。
content.declaration object または null ワークスペースの共通宣言。
pageInfo object レスポンスのトップレベルにあるページネーション情報。
pageInfo.pageIndex integer 現在のページ番号。
pageInfo.pageSize integer 1 ページあたりの件数。
pageInfo.count integer このページの件数。
pageInfo.totalCount integer 一致する総件数。このページに結果がない場合、現在の実装では 0 を返すことがあります。
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 21,
        "uuid": "dsbd_example",
        "name": "生产巡检",
        "desc": "生产服务巡检指标",
        "workspaceUUID": "wksp_example",
        "identifier": "prod-check",
        "ownerType": "node",
        "type": "CUSTOM",
        "chartPos": [],
        "chartGroupPos": [],
        "iconSet": {},
        "isPublic": 1,
        "extend": {},
        "mapping": [],
        "createdWay": "manual",
        "dashboardBindSet": [],
        "openPermissionSet": false,
        "permissionSet": [],
        "readPermissionSet": [],
        "tagInfo": [],
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "status": 0,
        "creatorInfo": {},
        "updatorInfo": {},
        "isFavorite": false,
        "isIndexDashboard": false,
        "refCheckerUUIDs": [],
        "allow_operation": true
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "count": 1,
    "totalCount": 1
  }
}

エラー応答

認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反した場合 パラメータの解析に失敗しました Query パラメータ表と例を確認してください。
500 ft.InternalServerError tagNames を JSON として解析できない場合、またはページング値がコントローラで整数に変換できない場合 内部エラー URL エンコードされた JSON 文字列配列を渡し、ページ番号と件数は 10 進整数で渡してください。

フィードバック

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