一覧¶
GET /api/v1/viewer/list
概要¶
現在のワークスペース内で表示可能なエクスプローラーをページングして一覧表示します。
呼び出し前の準備と使用手順¶
名前、タグ、フィルター範囲を組み合わせることができます。デフォルトではお気に入りを先に一覧表示し、その後更新時間の降順(更新時間がない場合は作成時間)で並べます。sortKey を明示した場合は指定フィールドで並べ替えます。content.data[].uuid を取得した後、エクスプローラー詳細を参照できます。結果がない場合、リストは空になります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sortKey | string | 省略時はデフォルトの並び順を使用します。フィールドを明示的に選択した場合はそのフィールドで並べ替えます。 null を許可: False 空文字列を許可: True 選択可能な値: ['name', 'updateAt'] 例: updateAt取得または入力方法: 表示要件に応じて name または updateAt から選択します。 |
|
| sortMethod | string | 並べ替え方向。デフォルトは desc です。 null を許可: False 空文字列を許可: True 選択可能な値: ['desc', 'asc'] 例: desc取得または入力方法: 昇順は asc、降順は desc を指定します。制御が不要な場合は省略します。 |
|
| search | string | 名前の部分一致で検索します。省略または空白の場合は名前でフィルターしません。 null を許可: False 例: 巡检取得または入力方法: 既存のエクスプローラーの名前からキーワードを選択します。 |
|
| pageIndex | integer | ページ番号。デフォルトは 1 です。 null を許可: False $minValue: 1 例: 1取得または入力方法: ページは 1 から開始します。 |
|
| pageSize | integer | 1 ページあたりの件数。デフォルトは 50、範囲は 1~100 です。 null を許可: False $minValue: 1 $maxValue: 100 例: 20取得または入力方法: 1 ページに必要な件数を入力します。 |
|
| filter | string | デフォルトは total です。total は表示可能なすべて、favorite はお気に入り、import はインポート元、myCreate は現在のアイデンティティで作成、oftenBrowse は最近よく閲覧、ofenBrowse との互換性あり、selfVisibleOnly は現在のアイデンティティ専用のプライベートエクスプローラーです。 null を許可: False 選択可能な値: ['total', 'favorite', 'import', 'myCreate', 'oftenBrowse', 'ofenBrowse', 'selfVisibleOnly'] 例: total取得または入力方法: 必要に応じてパラメータ説明内のフィルター値から選択します。 |
|
| tagNames | json | いずれかのタグ名に一致するものを検索します。 null を許可: False 例: ["team:ops"]取得または入力方法: 詳細の content.tagInfo[].name からタグを選択し、JSON 文字列配列を構成して URL エンコードします。 |
パラメータ補足説明¶
ページング情報はレスポンスのトップレベルにあります。Query の tagNames は JSON 文字列配列で表現します。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/viewer/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode 'search=巡检' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20 \
--data-urlencode sortKey=updateAt \
--data-urlencode sortMethod=desc
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
現在のページのエクスプローラーオブジェクト。 |
| content.data[].id | integer | エクスプローラーレコードの番号。 |
| content.data[].uuid | string | エクスプローラー UUID。 |
| content.data[].workspaceUUID | string | 所属ワークスペース。 |
| content.data[].name | string | エクスプローラー名。 |
| content.data[].desc | string | エクスプローラーの説明。 |
| content.data[].identifier | string | カスタム識別子。空の場合があります。 |
| content.data[].ownerType | string | エクスプローラーリソースの所有者種別。通常は viewer です。 |
| content.data[].type | string | エクスプローラーのタイプ。例: CUSTOM。 |
| content.data[].isPublic | integer | 現在のリソースの公開範囲。1 は公開、0 は作成したアイデンティティのみ表示可能です。 |
| content.data[].chartPos | array<object> |
チャートレイアウト配列。chartUUID とレイアウトオブジェクト pos を含みます。 |
| content.data[].chartPos[].chartUUID | string | 参照されるチャート UUID。 |
| content.data[].chartPos[].pos | object | レイアウトの位置とサイズ(x、y、w、h など)。 |
| content.data[].chartGroupPos | array<string> |
チャートグループの並び順。 |
| content.data[].iconSet | object | アイコン設定。 |
| content.data[].extend | object | エクスプローラーの拡張情報。 |
| content.data[].mapping | array<object> |
変数フィールドのマッピング情報。 |
| content.data[].dashboardBindSet | array | ビューのバインド設定。 |
| content.data[].createdWay | string | リソースの作成元。 |
| content.data[].openPermissionSet | boolean | エンティティレコードの権限設定スイッチ。 |
| content.data[].permissionSet | array<string> |
レコード内の操作権限主体 UUID。 |
| content.data[].readPermissionSet | array<string> |
レコード内の読み取り権限主体 UUID。 |
| content.data[].tagInfo | array<object> |
関連タグ情報。 |
| content.data[].tagInfo[].id | string | タグ UUID と同じ識別子。 |
| content.data[].tagInfo[].uuid | string | タグ UUID。 |
| content.data[].tagInfo[].name | string | タグ名。 |
| content.data[].tagInfo[].description | string | タグの説明。 |
| content.data[].tagInfo[].colour | string | タグの色。 |
| content.data[].tagInfo[].scope | array<string> |
タグが有効となるスコープ。 |
| content.data[].tagInfo[].tagPermissionInfo | object | 存在する場合は読み書き承認情報。 |
| content.data[].status | integer | レコードステータス。 |
| content.data[].creator | string | 作成者のアイデンティティ ID。 |
| content.data[].updator | string | 最終更新者のアイデンティティ ID。空の場合があります。 |
| content.data[].createAt | number | 作成時間(Unix 秒)。 |
| content.data[].updateAt | number | 更新時間(Unix 秒)。未更新の場合は -1 になることがあります。 |
| content.data[].deleteAt | number | 削除時間(Unix 秒)。未削除の場合は -1 です。 |
| content.data[].creatorInfo | object | 作成者情報。取得できない場合は空オブジェクトです。 |
| content.data[].updatorInfo | object | 最終更新者情報。取得できない場合は空オブジェクトです。 |
| content.data[].creatorInfo.uuid | string | 対応するアイデンティティが見つかった場合に提供されます。アイデンティティ識別子。 |
| content.data[].creatorInfo.status | integer | 対応するアイデンティティが見つかった場合に提供されます。アカウントステータス。 |
| content.data[].creatorInfo.wsAccountStatus | integer | 対応するアイデンティティが見つかった場合に提供されます。ワークスペースメンバーのステータス。 |
| content.data[].creatorInfo.username | string | 対応するアイデンティティが見つかった場合に提供されます。ログイン名。 |
| content.data[].creatorInfo.name | string | 対応するアイデンティティが見つかった場合に提供されます。表示名。 |
| content.data[].creatorInfo.iconUrl | string | 対応するアイデンティティが見つかった場合に提供されます。アバター URL。 |
| content.data[].creatorInfo.email | string | 対応するアイデンティティが見つかった場合に提供されます。アカウントのメールアドレス。API Key アイデンティティの場合はその識別子を返すことがあります。 |
| content.data[].creatorInfo.mobile | string | 対応するアイデンティティが見つかった場合に提供されます。連絡先。 |
| content.data[].creatorInfo.countryCode | string | 対応するアイデンティティが見つかった場合に提供されます。電話番号の国または地域コード。 |
| content.data[].creatorInfo.acntWsNickname | string | 対応するアイデンティティが見つかった場合に提供されます。ワークスペース内のニックネーム。 |
| content.data[].updatorInfo.uuid | string | 対応するアイデンティティが見つかった場合に提供されます。アイデンティティ識別子。 |
| content.data[].updatorInfo.status | integer | 対応するアイデンティティが見つかった場合に提供されます。アカウントステータス。 |
| content.data[].updatorInfo.wsAccountStatus | integer | 対応するアイデンティティが見つかった場合に提供されます。ワークスペースメンバーのステータス。 |
| content.data[].updatorInfo.username | string | 対応するアイデンティティが見つかった場合に提供されます。ログイン名。 |
| content.data[].updatorInfo.name | string | 対応するアイデンティティが見つかった場合に提供されます。表示名。 |
| content.data[].updatorInfo.iconUrl | string | 対応するアイデンティティが見つかった場合に提供されます。アバター URL。 |
| content.data[].updatorInfo.email | string | 対応するアイデンティティが見つかった場合に提供されます。アカウントのメールアドレス。API Key アイデンティティの場合はその識別子を返すことがあります。 |
| content.data[].updatorInfo.mobile | string | 対応するアイデンティティが見つかった場合に提供されます。連絡先。 |
| content.data[].updatorInfo.countryCode | string | 対応するアイデンティティが見つかった場合に提供されます。電話番号の国または地域コード。 |
| content.data[].updatorInfo.acntWsNickname | string | 対応するアイデンティティが見つかった場合に提供されます。ワークスペース内のニックネーム。 |
| content.data[].isFavorite | boolean | 現在のアイデンティティのお気に入り状態。詳細でお気に入りでない場合は返されないことがあります。 |
| content.data[].isIndexDashboard | boolean | 現在のワークスペースのホームビューかどうか。 |
| content.data[].refCheckerUUIDs | array<string> |
関連するモニターの識別子。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
| pageInfo | object | レスポンスのトップレベルにあるページングオブジェクト。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.count | integer | このページの件数。 |
| pageInfo.totalCount | integer | 一致するレコードの総数。現在の実装では空のページで 0 を返す場合があります。 |
{
"code": 200,
"content": {
"data": [
{
"id": 25,
"uuid": "dsbd_view_example",
"name": "主机巡检查看器",
"desc": "主机巡检与状态核对",
"workspaceUUID": "wksp_example",
"identifier": "",
"ownerType": "viewer",
"type": "CUSTOM",
"isPublic": 1,
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"extend": {},
"mapping": [],
"dashboardBindSet": [],
"createdWay": "manual",
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"tagInfo": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creatorInfo": {},
"updatorInfo": {},
"isFavorite": false,
"isIndexDashboard": false,
"refCheckerUUIDs": []
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
エラー応答¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 未宣言の Query パラメータを使用した場合、またはパラメータがルールに違反した場合 | パラメータの解析に失敗しました | Query パラメータの表と例を確認してください。 |
| 500 | ft.InternalServerError | tagNames の解析に失敗した場合、ページングを整数に変換できない場合、または並べ替え方法をコントローラーで処理できない場合 | 内部エラー | 例に従ってエンコード済みの JSON 配列文字列を渡し、ページングが整数であることを確認し、並べ替え方法には asc または desc のみを使用してください。 |