コンテンツにスキップ

メジャーメント一覧の取得(検索機能対応)



GET /api/v1/metric_info/measurement/list

概要

ワークスペースで当日検出されたメジャーメントを一覧表示します。名前は正規表現でフィルタリングできます。

呼び出し前の確認と使用手順

クエリ範囲はワークスペースのタイムゾーンにおける当日です。条件に一致するデータがない場合、結果フィールドは対応する空の配列になります。結果は名前の大文字と小文字を区別せずに並べ替えられます。返却結果には総件数が含まれないため、今回の limit より少ないレコードを受信した時点でページングを終了できます。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y AK 識別子。認証に使用します。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理で、本 API の権限を持つ Key を作成または取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
search string メジャーメント名に対して正規表現マッチングを行います。例えば ^cpu は cpu で始まる名前に一致します。省略または空欄の場合、範囲内のすべてのメジャーメントを返します。
null を許可: True
例: ^cpu
取得または入力方法: マッチ対象のメジャーメント名または正規表現を使用します。
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/measurement/list" \
  --data-urlencode "search=^cpu" \
  --data-urlencode "limit=10" \
  --data-urlencode "offset=0"

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content.data array<object> 結果一覧。一致する結果がない場合は空の配列です。
content.data[].name string メジャーメントの正確な名前。
content.data[].type string 固定で metric です。
content.data[].description string 現在は空文字列です。
content.declaration object または null ワークスペース宣言。この共通フィールドはレスポンスに含まれる場合があります。詳細は共通レスポンス構造を参照してください。
{"code": 200, "content": {"data": [{"name": "cpu", "type": "metric", "description": ""}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータが渡された リクエストフィールドの検証に失敗しました。メッセージにはフィールドまたはルールが示されます。 パラメータ表に記載されたパラメータのみを使用します。
403 ft.ForbiddenQuery 現在の認証情報に、リクエスト対象データをクエリする権限がない クエリ権限が不足しています。 API Key のクエリ権限と対象データの認可範囲を確認します。
503 ft.QueryServiceUnavailable 依存するクエリサービスが一時的に利用できない クエリサービスが一時的に利用できません。しばらくしてから再試行してください。 content.retryable を確認し、一時的なエラーの場合は遅延して再試行できます。
406 ft.DqlParseError ダウンストリームがリクエストパラメータから構築したクエリを解析できない DQL クエリ解析エラーです。詳細テキストは実際の式によって異なります。 正規表現の構文、フィールド、インデックス名を確認してください。可能な場合は一覧またはフィールド API から値を取得してください。
500 ft.InternalServerError limit または offset に整数へ変換できない文字列が渡された 内部エラーです。 パラメータ表で使用するページングフィールドを確認し、10 進整数の文字列を渡して再試行してください。

フィードバック

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