取得¶
GET /api/v1/dashboards/{dashboard_uuid}/get
概要¶
指定したダッシュボードの詳細、チャートレイアウト、関連情報を取得します。
呼び出し前の準備と使用手順¶
実際のダッシュボード UUID はダッシュボード一覧から取得します。レスポンスの UUID で対象を確認し、extend、mapping、タグ情報を使用して次の設定更新を準備します。インポート可能な完全なテンプレートが必要な場合は、エクスポート API を使用します。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dashboard_uuid | string | Y | 対象ダッシュボードの UUID。 例: dsbd_example取得・入力方法: ダッシュボード一覧の content.data[].uuid からコピーします。作成結果の content.uuid から取得することもできます。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | ダッシュボードのレコード番号。 |
| content.uuid | string | ダッシュボード UUID。詳細、変更、削除、カルーセルで使用します。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | ダッシュボードの表示名。 |
| content.desc | string | ダッシュボードの説明。 |
| content.identifier | string | 外部向けのカスタム識別子。空の場合があります。 |
| content.ownerType | string | リソースタイプの帰属。ダッシュボードは通常 node です。 |
| content.type | string | ダッシュボードのタイプ。例えば CUSTOM です。 |
| content.chartPos | array<object> |
チャートレイアウトの配列。各項目の chartUUID はチャート識別子、pos はレイアウトオブジェクトです。 |
| content.chartPos[].chartUUID | string | 関連付けられたチャート UUID。 |
| content.chartPos[].pos | object | チャートのサイズと位置。例えば x、y、w、h です。 |
| content.chartGroupPos | array<string> |
チャートグループ識別子の並び順。 |
| content.iconSet | object | アイコン設定。 |
| content.isPublic | integer | 1 は公開、0 は作成した ID のみ表示、-1 はカスタム権限。 |
| content.extend | object | 拡張設定。 |
| content.mapping | array<object> |
変数フィールドのマッピング。 |
| content.createdWay | string | リソースの作成元。 |
| content.dashboardBindSet | array | ビューバインド設定。 |
| content.openPermissionSet | boolean | カスタム権限が現在有効かどうか。 |
| content.permissionSet | array<string> |
操作権限の主体 UUID リスト。 |
| content.readPermissionSet | array<string> |
読み取り権限の主体 UUID リスト。 |
| content.tagInfo | array<object> |
このレスポンスに関連するタグ情報。 |
| content.tagInfo[].id | string | タグ識別子。uuid と同じです。 |
| content.tagInfo[].uuid | string | タグ UUID。 |
| content.tagInfo[].name | string | 関連付けられたタグ名。 |
| content.tagInfo[].description | string | タグの説明。 |
| content.tagInfo[].colour | string | タグの色。 |
| content.tagInfo[].scope | array<string> |
タグの適用範囲。 |
| content.tagInfo[].tagPermissionInfo | object | タグ認可が存在する場合に付与される操作権限と読み取り権限の情報。 |
| content.status | integer | レコードのステータス。 |
| content.creator | string | 作成者の ID。 |
| content.updator | string | 最終更新者の ID。更新がない場合は空になることがあります。 |
| content.createAt | number | 作成日時(Unix 秒)。 |
| content.updateAt | number | 最終更新日時(Unix 秒)。更新がない場合は -1 になることがあります。 |
| content.deleteAt | number | 削除日時(Unix 秒)。未削除の場合は -1 です。 |
| content.creatorInfo | object | 作成者情報。空のオブジェクトの場合があります。 |
| content.updatorInfo | object | 最終更新者情報。空のオブジェクトの場合があります。 |
| content.isFavorite | boolean | 現在の ID がお気に入りに登録しているかどうか。詳細結果では通常、お気に入り登録時のみ表示されます。 |
| content.isIndexDashboard | boolean | 現在のワークスペースのホームダッシュボードかどうか。 |
| content.refCheckerUUIDs | array<string> |
参照しているモニター UUID。 |
| content.allow_operation | boolean または null | 権限計算後の操作ヒント。存在する場合は編集可能かどうかの判断に使用します。 |
| content.permissionSetInfo | object | 操作権限リストが設定されている場合、UUID ごとに主体の詳細を返します。 |
| content.readPermissionSetInfo | object | 読み取り権限リストが設定されている場合、UUID ごとに主体の詳細を返します。 |
| content.extend.defaultTargetWorkspaceName | string | 旧来の単一デフォルトクエリスペースフィールドに対応する表示名。詳細で提供される場合があります。 |
| content.extend.defaultTargetWorkspaceNames | array<string> |
デフォルトクエリスペースリストが設定されている場合、そのリストに対応する表示名。詳細で提供される場合があります。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"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,
"declaration": {},
"creatorInfo": {},
"updatorInfo": {},
"isIndexDashboard": false,
"refCheckerUUIDs": [],
"allow_operation": true
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundView | 対象のダッシュボードが存在しない、削除済み、または現在のワークスペースにない | 指定されたビューが見つかりません | 現在のワークスペースのダッシュボード一覧から返された UUID に切り替えてください。 |
| 403 | ft.ForbiddenDashboardQueryOperation | 呼び出し元の ID に対象ダッシュボードの読み取り権限がない | ダッシュボード【{}】を表示する権限がありません | 対象が呼び出し元の ID に読み取り権限を開放しているか確認してください。 |