コンテンツにスキップ

メトリクスとタグ情報の取得



GET /api/v1/metric_info/get

概要

指定したメジャーメントのメタデータと、取得済みの Tag の説明を読み取ります。

呼び出し前と使用手順

まずメジャーメント名を取得してから、フィールドの説明、測定単位、既存の Tag の説明を読み取ることができます。一致するフィールドメタデータまたは Tag がない場合、対応する配列は空になります。

リクエストヘッダー

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

Query リクエストパラメータ

パラメータ名 型 必須 説明
metric string Y メジャーメントの正確な名前。例: cpu。
null を許可: False
空文字列を許可: 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/get" \
  --data-urlencode "metric=cpu"

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content.metric_fields_info array<object> 結果リスト。一致する結果がない場合は空の配列です。
content.metric_fields_info[].field string メトリクスフィールド名。
content.metric_fields_info[].type string フィールドメタデータのソース。inner は組み込み、custom はカスタムです。
content.metric_fields_info[].data_type string または null フィールドのデータ型。
content.metric_fields_info[].unit string メトリクスの単位。空の場合があります。
content.metric_fields_info[].desc string メトリクスフィールドの説明。
content.metric_fields_info[].tags array<string> このフィールドに対応する Tag 名。
content.metric_fields_info[].origin_field string 元のフィールド名。一部の設定で返されます。
content.tags_info array<object> 結果リスト。一致する結果がない場合は空の配列です。
content.tags_info[].tag_key string Tag 名。
content.tags_info[].tag_desc string Tag の説明。空の場合があります。
content.declaration object または null ワークスペース宣言。この共通フィールドはレスポンスに含まれる場合があります。詳細は共通レスポンス構造を参照してください。
{"code": 200, "content": {"metric_fields_info": [{"field": "usage_idle", "type": "inner", "data_type": "float", "unit": "percent", "desc": "空闲百分比", "tags": ["host"]}], "tags_info": [{"tag_key": "host", "tag_desc": "主机名"}]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}

エラーレスポンス

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

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

フィードバック

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