ログインデックス一覧の取得¶
GET /api/v1/metric_info/log/indexes
概要¶
現在のワークスペースで表示可能かつカスタムストレージにバインドされていない logging および standard ログインデックスを一覧表示します。
呼び出し前の準備と使用手順¶
返されたインデックス名を使用して、ログフィールドまたは Tag 値のインターフェースを呼び出します。一覧には総件数が含まれないため、今回の limit より少ないレコードを受信した時点でページングを終了できます。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 識別子。認証に使用します。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理で、本インターフェースの権限を持つ Key を作成または取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| limit | integer | デフォルト値は 100 です。正の整数を指定してください。 null を許可: True デフォルト値: 100 例: 100取得または入力方法: クライアントが 1 回に読み取る件数を指定します。 |
|
| offset | integer | 読み取りを開始する位置(0 からカウント、デフォルト値は 0)。 null を許可: True デフォルト値: 0 例: 0取得または入力方法: 最初のページでは 0 を指定します。以降のページでは、前回の offset に limit を加算します。 |
パラメータの補足説明¶
GET を使用して、現在の API Key が属するワークスペースのデータを読み取ります。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/log/indexes" \
--data-urlencode "limit=100" \
--data-urlencode "offset=0"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
結果一覧。一致する結果がない場合は空の配列です。 |
| content.data[].name | string | ログインデックスの名前(例: default)。 |
| content.declaration | object または null | ワークスペース宣言。この共通フィールドはレスポンスに含まれる場合があります。詳細は共通レスポンス構造を参照してください。 |
{"code": 200, "content": {"data": [{"name": "default"}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータが渡された | リクエストフィールドの検証に失敗しました。メッセージにはフィールドまたはルールが示されます。 | パラメータ表に記載されているパラメータのみを使用してください。 |
| 500 | ft.InternalServerError | limit または offset に整数へ変換できない文字列が渡された | 内部エラー。 | パラメータ表で使用するページングフィールドを確認し、10 進整数の文字列を渡して再試行してください。 |