コンテンツにスキップ

リクエスト例


本ドキュメントでは、一部の Open API のリクエスト例を紹介します。

GET リクエスト

ダッシュボード一覧取得インターフェースを例に

リクエストは以下の通りです。

curl "https://openapi.guance.com/api/v1/dashboards/list?pageIndex=1&pageSize=10" \
  -H "Content-Type: application/json" \
  -H "DF-API-KEY: ${DF_API_KEY}" \
  --compressed \
  --insecure

レスポンス結果は以下の通りです。

{
    "code":200,
    "content":[
        {Object}
    ],
    "errorCode":"",
    "message":"",
    "pageInfo":{
        "count":10,
        "pageIndex":1,
        "pageSize":10,
        "totalCount":836
    },
    "success":true,
    "traceId":"1749091119335873001"
}

POST リクエスト

ダッシュボード削除インターフェースを例に

リクエストは以下の通りです。

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

レスポンス結果は以下の通りです。

{
    "code":200,
    "content":true,
    "errorCode":"",
    "message":"",
    "success":true,
    "traceId":"4250149955169518608"
}

補足

${DF_API_KEY}:呼び出し元の API KEY を表します。取得方法については、API Key 管理 を参照してください。

フィードバック

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