コンテンツにスキップ

取得



GET /api/v1/dashboard/{dashboard_uuid}/get

概要

指定した組み込みビューの設定、グラフレイアウト、バインディング条件を取得します。

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

まず組み込みビュー一覧で UUID を取得します。バインディングを変更して保持する場合は、先に content.dashboardBidding を読み取って保存します。移植可能なテンプレートコンテンツが必要な場合は、組み込みビューのエクスポートを呼び出してください。

ルートパラメータ

パラメータ名 型 必須 説明
dashboard_uuid string Y 現在のワークスペースの組み込みビュー UUID。
例: dsbd_inner_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/dashboard/dsbd_inner_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 組み込みビューのリソース帰属。組み込みビューの場合は inner。
content.type string 組み込みビューのタイプ。例: CUSTOM。
content.isPublic integer 詳細のアクセス範囲。1 は公開、0 は作成したアイデンティティのみアクセス可能。
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.extend object 組み込みビューの拡張情報。
content.mapping array<object> 変数フィールドのマッピング情報。
content.dashboardBindSet array ビューのバインディング設定。
content.createdWay string リソースの作成元。
content.openPermissionSet boolean エンティティレコードの権限設定スイッチ。
content.permissionSet array<string> レコード内の操作権限主体 UUID。
content.readPermissionSet array<string> レコード内の読み取り権限主体 UUID。
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.creatorInfo.uuid string 対応するアイデンティティが取得できた場合に提供されます。アイデンティティ識別子。
content.creatorInfo.status integer 対応するアイデンティティが取得できた場合に提供されます。アカウント状態。
content.creatorInfo.wsAccountStatus integer 対応するアイデンティティが取得できた場合に提供されます。ワークスペースメンバー状態。
content.creatorInfo.username string 対応するアイデンティティが取得できた場合に提供されます。ログイン名。
content.creatorInfo.name string 対応するアイデンティティが取得できた場合に提供されます。表示名。
content.creatorInfo.iconUrl string 対応するアイデンティティが取得できた場合に提供されます。アバター URL。
content.creatorInfo.email string 対応するアイデンティティが取得できた場合に提供されます。アカウントのメールアドレス。API Key アイデンティティの場合はその識別子が返ることがあります。
content.creatorInfo.mobile string 対応するアイデンティティが取得できた場合に提供されます。連絡先。
content.creatorInfo.countryCode string 対応するアイデンティティが取得できた場合に提供されます。電話番号の国または地域コード。
content.creatorInfo.acntWsNickname string 対応するアイデンティティが取得できた場合に提供されます。ワークスペース内のニックネーム。
content.updatorInfo.uuid string 対応するアイデンティティが取得できた場合に提供されます。アイデンティティ識別子。
content.updatorInfo.status integer 対応するアイデンティティが取得できた場合に提供されます。アカウント状態。
content.updatorInfo.wsAccountStatus integer 対応するアイデンティティが取得できた場合に提供されます。ワークスペースメンバー状態。
content.updatorInfo.username string 対応するアイデンティティが取得できた場合に提供されます。ログイン名。
content.updatorInfo.name string 対応するアイデンティティが取得できた場合に提供されます。表示名。
content.updatorInfo.iconUrl string 対応するアイデンティティが取得できた場合に提供されます。アバター URL。
content.updatorInfo.email string 対応するアイデンティティが取得できた場合に提供されます。アカウントのメールアドレス。API Key アイデンティティの場合はその識別子が返ることがあります。
content.updatorInfo.mobile string 対応するアイデンティティが取得できた場合に提供されます。連絡先。
content.updatorInfo.countryCode string 対応するアイデンティティが取得できた場合に提供されます。電話番号の国または地域コード。
content.updatorInfo.acntWsNickname string 対応するアイデンティティが取得できた場合に提供されます。ワークスペース内のニックネーム。
content.isIndexDashboard boolean 現在のアイデンティティに対して返されるワークスペースのホームビューかどうか。
content.refCheckerUUIDs array<string> このビューに関連付けられたモニター UUID。
content.dashboardBidding object バインディング条件オブジェクト。バインディングがない場合は空オブジェクト。
content.dashboardBidding.* array<object> 実際のソースフィールドごとに構成されるマッチング条件の配列。
content.dashboardBidding.*[].op string マッチング演算子。
content.dashboardBidding.*[].value array<string> マッチング値の配列。
content.tagInfo array<object> 組み込みビューでは現在空の配列が返されます。
content.declaration object または null ワークスペースのパブリック宣言。
{
  "code": 200,
  "content": {
    "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,
    "dashboardBidding": {
      "host": [
        {
          "op": "in",
          "value": [
            "web-01"
          ]
        }
      ]
    },
    "tagInfo": [],
    "isIndexDashboard": false,
    "refCheckerUUIDs": [],
    "creatorInfo": {},
    "updatorInfo": {},
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対応方法
404 ft.NotFoundView 対象が存在しない、削除済み、またはこのワークスペースに属していない 指定されたビューが見つかりません 同じワークスペースの組み込みビュー一覧から有効な UUID を取得します。
403 ft.ForbiddenOperationResource API Key に対象ビューの有効な操作権限がない 現在操作権限がありません ワークスペースの帰属と API Key の権限を確認するか、リソース作成者に連絡します。
403 ft.ForbiddenAccessResourceNoPublic プライベートビューにアクセスするアイデンティティがビューの作成アイデンティティと異なる リソースへのアクセス権限がありません。現在のページは非公開状態です アクセス権を持つ作成アイデンティティで操作し、同じワークスペースの API Key を使用していることを確認します。

フィードバック

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