メトリクス Tags 情報の取得¶
GET /api/v1/metric_info/measurement/tags
概要¶
指定したメジャーメントの特定の Tag の値をサンプリングして取得します。
呼び出し前の準備と使用手順¶
クエリ範囲はワークスペースのタイムゾーンにおける当日です。条件に一致するデータがない場合、結果フィールドは対応する空の配列になります。 一部の非 null 値のみを返すため、過去のすべての値を列挙する目的には使用できません。上流クエリ結果に含まれる null、空文字列、0、false はサンプルリストに含まれません。 メジャーメント名または Tag 名が空の場合、成功を返し、content は {} になります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 識別子。認証に使用します 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理で、この API の権限を持つ Key を作成または取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| measurement | string | Y | メジャーメントの正確な名前。例: cpu。 null の許可: False 例: cpu取得または入力方法: メジャーメント一覧の取得 レスポンスの content.data[].name から取得します。 |
| tag | string | Y | Tag 名を指定します。例: host。 null の許可: False 例: host取得または入力方法: メジャーメントスキーマの取得 レスポンスの content.fields[].tags[].name から取得します。 |
| limit | integer | デフォルトは 10 です。10 より大きい値は 10 として処理されます。正の整数を渡してください。 null の許可: True デフォルト値: 10 例: 10取得または入力方法: 呼び出し元が必要とするサンプル数に応じて設定します。1 から 10 を推奨します。 |
パラメータ補足説明¶
GET を使用して、現在の API Key が属するワークスペースのデータを読み取ります。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
"https://openapi.guance.com/api/v1/metric_info/measurement/tags" \
--data-urlencode "measurement=cpu" \
--data-urlencode "tag=host" \
--data-urlencode "limit=10"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content.measurement | string | リクエスト内のメジャーメント名。 |
| content.tag | string | リクエスト内のフィールドまたは Tag 名。 |
| content.values | array | サンプリング値。要素の型はデータソースのフィールドによって異なります。一致する値がない場合は空の配列です。 |
| content.declaration | object または null | ワークスペース宣言。この共通フィールドはレスポンスに含まれる場合があります。詳細は共通レスポンス構造を参照してください。 |
{"code": 200, "content": {"measurement": "cpu", "tag": "host", "values": ["web-01", "web-02"]}, "errorCode": "", "message": "", "success": true, "traceId": "TRACE-EXAMPLE"}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 必須の Query パラメータが不足しているか、宣言されていない Query パラメータが渡されています | リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されます。 | パラメータ表と例を確認します。 |
| 403 | ft.ForbiddenQuery | 現在の認証情報に、リクエストに対応するデータをクエリする権限がありません | クエリ権限が不足しています。 | API Key のクエリ権限と対象データの認可範囲を確認します。 |
| 503 | ft.QueryServiceUnavailable | 依存するクエリサービスが一時的に利用できません | クエリサービスが一時的に利用できません。しばらくしてから再試行してください。 | content.retryable を確認します。一時的なエラーの場合は遅延して再試行できます。 |
| 500 | ft.InternalServerError | limit に整数へ変換できない文字列が渡されています | 内部エラー。 | パラメータ表で使用しているページネーションフィールドを確認し、10 進整数の文字列を渡して再試行します。 |