一覧表示¶
GET /api/v1/dashboard/inner_list
概要¶
現在のワークスペースに存在するユーザー組み込みビューを一覧表示します。
呼び出し前の準備と使用手順¶
名前で検索できます。結果はレコード番号の降順で返され、ページネーションはありません。content.data[].uuid を使用して組み込みビュー詳細をリクエストします。条件に一致するビューがない場合は空のリストを返します。リストには、未インストールのシステムテンプレートは個別に表示されません。プライベート項目もリストに表示される場合があります。詳細および後続の操作では、引き続きそのビューの権限チェックを通過する必要があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| search | string | 名前の部分一致で検索します。省略または空の場合、名前によるフィルタリングは行いません。 null の許可: False 例: 主机取得または入力方法: 検索対象の組み込みビュー名からキーワードを取得します。 |
パラメータの補足説明¶
バインド条件は詳細でのみ提供されます。絞り込みの基準はビュー名です。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/dashboard/inner_list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode 'search=主机'
レスポンス¶
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 | 組み込みビューリソースの帰属。組み込みビューの場合は inner です。 |
| content.data[].type | string | 組み込みビューのタイプ。例: CUSTOM。 |
| content.data[].isPublic | integer | 詳細へのアクセス範囲。1 は公開、0 は作成した ID のみアクセス可能です。 |
| 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[].extend | object | 組み込みビューの拡張情報。 |
| content.data[].mapping | array<object> |
変数フィールドのマッピング情報。 |
| content.data[].dashboardBindSet | array | ビューのバインド設定。 |
| content.data[].createdWay | string | リソースの作成元。 |
| content.data[].openPermissionSet | boolean | エンティティレコードの権限設定スイッチ。 |
| content.data[].permissionSet | array<string> |
レコード内の操作権限主体 UUID。 |
| content.data[].readPermissionSet | array<string> |
レコード内の読み取り権限主体 UUID。 |
| 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[].innerTemplate | object または null | ビュー名がシステム組み込みテンプレートに一致した場合、テンプレートの概要が付加されます。 |
| content.data[].innerTemplate.uuid | string | 一致したシステムテンプレートの UUID。 |
| content.data[].innerTemplate.name | string | システムテンプレート名。 |
| content.data[].innerTemplate.path | string | システムテンプレートのパス。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"data": [
{
"id": 72,
"uuid": "dsbd_inner_example",
"name": "主机详情内置视图",
"desc": "根据主机查看运行状态",
"workspaceUUID": "wksp_example",
"identifier": "host-overview",
"ownerType": "inner",
"type": "CUSTOM",
"isPublic": 1,
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"extend": {},
"mapping": [],
"dashboardBindSet": [],
"createdWay": "manual",
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"innerTemplate": null
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |