Open API¶

Guance は、Open API インターフェースを呼び出すことで、ワークスペースデータの取得や更新をサポートしています。

API の詳細なリストについては、Guance Open API ドキュメントライブラリ を参照してください。

認証方式¶

API インターフェースを呼び出す前に、まず API Key を作成し、認証方式として使用する必要があります。

インターフェースは API Key を認証方式として採用し、リクエストヘッダーの DF-API-KEY フィールドでリクエストの有効性を検証し、リクエストが所属するワークスペース（この API Key が所属するワークスペースに基づく）を特定します。

すべての GET リクエスト（データのクエリや取得に使用）は、リクエストヘッダーに DF-API-KEY を認証情報として提供するだけで済みます。

リクエスト構造¶

例：ダッシュボードの削除（POST リクエスト）

curl -X POST "https://openapi.guance.com/api/v1/dashboard/dsbd_922428e594ba44ce87229b8ca3007a90/delete" \
-H "Content-Type: application/json" \
-H "DF-API-KEY: ${DF_API_KEY}"

接続アドレス Endpoint¶

インターフェースルートアドレス仕様¶

インターフェースルートは、一般的に以下の命名規則に従います。

例：

• ダッシュボードリストの取得：/api/v1/dashboard/list
• ダッシュボードの作成：/api/v1/dashboard/create
• ダッシュボードの取得：/api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/get
• ダッシュボードの削除：/api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/delete
• ダッシュボードの変更：/api/v1/dashboard/dsbd_0e233ee4804aca011ba94a9164a9ed7f/modify
• ホストオブジェクトリストの取得：/api/v1/object/host/list
• プロセスオブジェクトリストの取得：/api/v1/object/process/list

戻り値¶

インターフェースの戻り値は、HTTP リクエストレスポンスの仕様に従います。

• 正常なリクエストは HTTP ステータスコード 200 を返します
• API Key の認証失敗は HTTP ステータスコード 403 を返します
• サーバー側で処理できない、または不明なエラーは HTTP ステータスコード 500 を返します
• その他のエラー（データへのアクセス権限がない、操作対象が見つからないなど）は、それぞれ 403 や 404 などを返します。具体的なエラー定義は以下を参照してください。

レスポンス結果の例¶

{
    "code":200,
    "content":{

    },
    "pageInfo": {
        "count": 20,
        "pageIndex": 1,
        "pageSize": 100,
        "totalCount": 10
    },
    "errorCode":"",
    "message":"",
    "success":true,
    "traceId":"3412000720344969928"
}

共通レスポンス結果パラメータ¶

共通エラー定義¶

API インターフェースリストの詳細については、Open API ドキュメントライブラリ を参照してください。