コンテンツにスキップ

一覧



GET /api/v1/dashboard/carousel/list

概要

現在の呼び出し元 ID がワークスペース内に持つカルーセル設定を一覧表示します。

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

作成時と同じワークスペースおよび呼び出し元 ID で照会します。リストはレコード ID の降順で並び、ページネーションはありません。読み取り時に、設定内で削除済み、またはこのワークスペースに存在しないダッシュボードの参照がクリーンアップされます。結果の 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/carousel/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=巡检'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。

フィールド 型 説明
content array<object> 設定リスト。一致するレコードがない場合は空の配列です。
content[].id integer カルーセルレコードの内部番号。
content[].uuid string カルーセル設定の UUID。詳細、変更、削除に使用します。
content[].accountUUID string カルーセルが属する呼び出し元 ID の ID。
content[].workspaceUUID string カルーセルが属するワークスペースの UUID。
content[].name string カルーセル名。
content[].intervalTime string 保存済みのカルーセル間隔文字列。
content[].dashboardUUIDs array<string> 保存済みのダッシュボード UUID。カルーセルの表示順に並びます。
content[].status integer レコードステータス。
content[].createAt number 作成日時。Unix 秒。
content[].updateAt number 最終更新日時。Unix 秒。更新がない場合は -1。
content[].deleteAt number 削除日時。Unix 秒。未削除の場合は -1。
content[].creator string 作成者の ID。
content[].updator string 最終更新者の ID。更新がない場合は空文字列。
content[].declaration object または null ワークスペースの公開宣言。
{
  "code": 200,
  "content": [
    {
      "id": 10,
      "uuid": "csel_example",
      "accountUUID": "wsak_example",
      "workspaceUUID": "wksp_example",
      "name": "生产巡检轮播",
      "intervalTime": "30s",
      "dashboardUUIDs": [
        "dsbd_example"
      ],
      "status": 0,
      "createAt": 1785427200,
      "updateAt": -1,
      "deleteAt": -1,
      "creator": "wsak_example",
      "updator": "",
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している パラメータの解析に失敗しました Query パラメータ表と例を確認してください。

フィードバック

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