コンテンツにスキップ

メジャーメントスキーマ情報を取得



GET /api/v1/metric_info/measurement/schema

概要

指定したメジャーメントで当日検出されたフィールド、フィールドタイプ、Tag 情報を取得します。

呼び出し前および使用手順

クエリ範囲はワークスペースのタイムゾーンでの当日です。条件に一致するデータがない場合、結果の各フィールドは対応する空の配列になります。 自動検出とカスタムメタデータの両方が存在するフィールドでは、カスタム設定を使用します。先にメジャーメントを取得し、返されたフィールド名と Tag 名を使用してクエリを構築できます。 メジャーメント名を空にした場合、成功が返され、content は {} になります。

リクエストヘッダー

パラメータ名 型 必須 説明
Accept-Language string フィールドと Tag のローカライズ可能な説明に使用する言語を決定します。
例: zh
取得または入力方法: 返される説明に必要な言語を指定します。例: zh。
DF-API-KEY string Y 認証に使用する AK 識別子
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理で、この API の権限を持つ Key を作成または取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
measurement string Y メジャーメントの正確な名前。例: cpu。
null を許可: False
例: cpu
取得または入力方法: メジャーメント一覧の取得 のレスポンスにある content.data[].name から値を取得します。

パラメータの補足説明

GET を使用して、現在の API Key が属するワークスペースのデータを読み取ります。

リクエスト例

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  "https://openapi.guance.com/api/v1/metric_info/measurement/schema" \
  --data-urlencode "measurement=cpu"

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content.measurement string リクエスト内のメジャーメント名。
content.fields array<object> 結果リスト。一致する結果がない場合は空の配列です。
content.fields[].name string メトリクスフィールド名。
content.fields[].value_type string メトリクスフィールドの値型。
content.fields[].type string フィールドの値型が空でない場合は gauge、それ以外は空文字列です。
content.fields[].unit string 設定された単位。空文字列の場合があります。
content.fields[].description string 設定された説明。空文字列の場合があります。
content.fields[].tags array<object> このフィールドの Tag 一覧。
content.fields[].tags[].name string Tag の正確な名前。
content.fields[].tags[].description string Tag の説明。空文字列の場合があります。
content.declaration object または null ワークスペース宣言。この共通フィールドはレスポンスに含まれる場合があります。詳細は共通レスポンス構造を参照してください。
{"code": 200, "content": {"measurement": "cpu", "fields": [{"name": "usage_idle", "value_type": "float", "type": "gauge", "unit": "percent", "description": "", "tags": [{"name": "host", "description": ""}]}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 必須の Query パラメータが不足しているか、宣言されていない Query パラメータが渡されています リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されています。 パラメータ表と例を確認してください。
403 ft.ForbiddenQuery 現在の認証情報に、リクエスト対象データをクエリする権限がありません クエリ権限が不足しています。 API Key のクエリ権限と対象データの認可範囲を確認してください。
503 ft.QueryServiceUnavailable 依存するクエリサービスが一時的に利用できません クエリサービスが一時的に利用できません。後で再試行してください。 content.retryable を確認し、一時的なエラーの場合は時間をおいて再試行できます。

フィードバック

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