service map¶
GET /api/v1/tracing/service_map_v2
概要¶
単一のワークスペースについて、指定した時間枠のサービスノード、呼び出しエッジ、統計データを読み取ります。
呼び出し前の確認と使用手順¶
r または w 権限の External 署名を使用します。詳細はExternal API 署名認証を参照してください。workspaceUUID は毎回 1 つのアクティブなワークスペースを指定し、start/end はミリ秒、署名時刻は別途現在の秒を使用します。複数のワークスペースは同じ時間枠と groupBy で個別にリクエストし、クライアント側でマージしてワークスペースの識別情報を保持してください。全ワークスペースのサービスマップでは centralService、search、制限用の filters を省略します。単一サービスの上流/下流を全ワークスペースのエクスポートとして扱うことはできません。groupBy を優先して使用してください。空または無効な groupBy でも旧ブールスイッチを上書きします。env/version でグループ化する場合は実際の中心ディメンションで同名サービスを特定します。省略と明示的な空文字列は意味が異なります。services/maps JSON を読み取ります。呼び出しエッジのページネーションやファイルダウンロードはありません。エッジ端点に対応するノードが返されない場合がありますが、そのエッジを破棄しないでください。id + ワークスペース + グループが関連付けを決定します。重複するエッジを直接合算したり P99 を平均したりしないでください。HTTP/ビジネスステータスが成功し、両方の配列構造が正常な場合に限り、[] を空のサービスマップとして扱います。所要時間は元のマイクロ秒値を保持します。エラー比率 0.01 は 1% です。ノードとエッジでは統計範囲が異なるため、混在して加算できません。一括エクスポートについてはExternal API によるサービスマップのエクスポートを参照してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョン。省略したまま本ページのアルゴリズムを継続使用することはできません。 例: v20240417取得または入力方法: 本ページの例ではこの固定バージョンを使用し、例の署名アルゴリズムと組み合わせます。 |
|
| X-Df-Access-Key | string | Y | 読み取り API では r または w の資格情報を使用でき、書き込み API では w の資格情報が必要です。 例: <external-access-key>取得または入力方法: サイト管理者が割り当てた External API AK を使用します。ワークスペースの OpenAPI Key は使用できません。 |
| X-Df-Nonce | string | Y | 一時的なシーケンス番号。失敗して再送する場合も新しい値を生成し、署名を再計算します。 例: 97d275ee9f774315a7885ba7347acbd9取得または入力方法: リクエストごとに uuid.uuid4().hex を再生成します。 |
| X-Df-Signature | string | Y | 大文字のメソッド、nonce、元の完全なパス、timestamp、および元の UTF-8 リクエストボディをスペースで連結し、HMAC-SHA256 を適用して hex ダイジェストを取得します。 例: <hmac-sha256-hex>取得または入力方法: External API 署名認証に従って対応する SK で計算します。完全に実行可能なテンプレートは以下を参照してください。 |
| X-Df-Timestamp | string | Y | サイトに設定された署名有効時間枠内である必要があり、例の時刻を再利用できません。 例: 1785427200取得または入力方法: 送信時に str(int(time.time())) を使用して現在の Unix 秒文字列を生成します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| filters.tags | array | tags オブジェクト形式を含む条件リスト。この配列を直接 filters JSON のルートとして使用することもできます。 例: [{"name": "service", "operation": "in", "value": ["checkout-api"], "condition": "and"}]取得または入力方法: 実際の APM タグと検証済みのクエリ条件から構築します。このパスは filters 文字列をデコードした後の構造を表します。 |
|
| filters.tags[*] | json | リーフ条件、または filters を含む再帰的なグループオブジェクト。 例: {"name": "service", "operation": "in", "value": ["checkout-api"], "condition": "and"}取得または入力方法: 実際の APM タグと検証済みのクエリ条件から構築します。このパスは filters 文字列をデコードした後の構造を表します。 |
|
| filters.tags[*].name | string | リーフのフィールド名。実際に収集されたタグから取得します。空でないことが必須です。 例: service取得または入力方法: 実際の APM タグと検証済みのクエリ条件から構築します。このパスは filters 文字列をデコードした後の構造を表します。 |
|
| filters.tags[*].operation | string | リーフの演算子。一般的に =、!=、in、notin、=~、wildcard、exists などを下流のサポートに応じて選択します。互換用の op を使用できます。両方を省略すると内部エラーになります。 例: in取得または入力方法: 実際の APM タグと検証済みのクエリ条件から構築します。このパスは filters 文字列をデコードした後の構造を表します。 |
|
| filters.tags[*].value | array | リーフの一致値配列。実際のフィールド型に応じて入力します。指定が必須で、空配列はワイルドカードとして扱われません。 例: ["checkout-api"]取得または入力方法: 実際の APM タグと検証済みのクエリ条件から構築します。このパスは filters 文字列をデコードした後の構造を表します。 |
|
| filters.tags[*].condition | string | 直前の項目との論理関係(and/or)。デフォルトは and です。互換用の logic を使用できます。 例: and取得または入力方法: 実際の APM タグと検証済みのクエリ条件から構築します。このパスは filters 文字列をデコードした後の構造を表します。 |
|
| filters.tags[*].filters | array | グループ化された子条件の配列。再帰構造は外側と同じです。空でないグループは condition で結合されます。 例: [{"name": "service", "operation": "in", "value": ["checkout-api"], "condition": "and"}]取得または入力方法: 実際の APM タグと検証済みのクエリ条件から構築します。このパスは filters 文字列をデコードした後の構造を表します。 |
|
| centralClusterNameK8s | string | 中心アイデンティティのディメンション。省略すると関与せず、明示的な空白は未設定に一致します。グループと中心サービスが必要です。 例: production-k8s取得または入力方法: 中心ノードの cluster_name_k8s から値を取得します。 |
|
| centralEnv | string | 中心環境のディメンション。省略すると制限せず、明示的な空白は未設定に一致します。グループと中心サービスが必要です。 例: production取得または入力方法: 中心ノードの data.env または対応する環境タグから値を取得します。 |
|
| centralProject | string | グループがあり、centralService が空でない場合にのみ中心アイデンティティに参加します。このキーを省略するとこのディメンションを制限せず、明示的な空/すべて空白は project が未設定であることに完全一致します。 例: production取得または入力方法: 中心ノードの project 収集タグから値を取得します。 |
|
| centralService | string | オプションの中心サービス。先頭と末尾の空白は除去します。省略すると全ワークスペースです。有効な groupBy が存在する場合は中心オブジェクトで照合し、グループ化されていない場合はサービス名で上流/下流をクエリします。 例: checkout-api取得または入力方法: content.services[].data.service/name から実際のサービス名を取得します。ノード id ではありません。 |
|
| centralVersion | string | 中心バージョンのディメンション。省略すると制限せず、明示的な空白は未設定に一致します。グループと中心サービスが必要です。 例: v1取得または入力方法: 中心ノードの data.version またはバージョンタグから値を取得します。 |
|
| centralWorkspaceUUID | string | グループがあり、centralService が空でない場合に有効になります。省略/空白の場合は workspaceUUID を使用します。公開エントリポイントは 1 つのワークスペースを対象にクエリし、これをクロスワークスペースの認可パラメータとして扱いません。 例: wksp_example001取得または入力方法: その中心ノードの workspace_uuid を取得します。 |
|
| end | integer | Y | 必須の終了ミリ秒整数。時間枠には実際のトレース収集データが存在する必要があります。 例: 1785430800000取得または入力方法: 同じ時間基準の実際のウィンドウ終了 Unix ミリ秒を使用します。 |
| filters | string | オプションの JSON 文字列。tags 配列を含むオブジェクト、または条件オブジェクトの配列を使用できます。省略するとフィルタリングせず、[] は空条件です。fields オブジェクトや {} だけを渡さないでください。現在の正規化ではオブジェクトが残り、条件配列として扱われない可能性があります。operation/op および condition/logic は互換です。無効な JSON/オブジェクト構造は 500 になる可能性があります。これはリクエスト JSON ボディではありません。 例: {"tags":[{"name":"service","operation":"in","value":["checkout-api"],"condition":"and"}]}取得または入力方法: 収集済みの APM サービス/タグ結果から service、env、version などの実際のフィールドと値を選択します。JSON 文字列全体を urlencode でエンコードします。 |
|
| groupBy | commaArray | 推奨されるグループ化フィールド。英語のカンマ区切り文字列です。project、cluster_name_k8s、env、version の任意の組み合わせで、service_sub は env+version に展開されます。フィールド名は空白/バッククォートを除去して小文字化し、重複を排除し、固定順序で返します。未知の値は無視します。このキーが存在するだけで優先され、空文字列またはすべて無効な値の場合は service のみでグループ化し、旧スイッチを上書きします。 例: project,env,version取得または入力方法: 同名サービスを区別する必要がある場合は、収集タグに応じて選択します。 |
|
| groupByClusterNameK8S | boolean | 小文字 s のバージョンが存在しない場合にのみ使用します。両者を異なるディメンションとして扱うことはできません。 例: false取得または入力方法: 過去の大文字/小文字の同義名です。groupByClusterNameK8s を優先して使用してください。 |
|
| groupByClusterNameK8s | boolean | groupBy/group_by がない場合にのみ cluster_name_k8s を追加します。デフォルトは false です。 例: false取得または入力方法: 旧クライアントで K8s クラスタ名ごとに分割する必要がある場合は true です。 |
|
| groupByProject | boolean | groupBy/group_by がない場合にのみ project ディメンションを追加します。デフォルトは false です。 例: false取得または入力方法: 旧クライアントで project ごとにノードを分割する場合は true です。 |
|
| group_by | commaArray | groupBy が存在しない場合にのみこの同義フィールドを使用します。空文字列が出現した場合も旧スイッチを上書きします。同時に渡さないでください。 例: env,version取得または入力方法: 旧クライアント向けの互換フィールドです。groupBy への移行を推奨します。 |
|
| group_by_cluster_name_k8s | boolean | 前述の大文字/小文字 2 フィールドがいずれも存在しない場合にのみ使用します。 例: false取得または入力方法: 旧フィールド名との互換用です。groupByClusterNameK8s を推奨します。 |
|
| group_by_project | boolean | groupByProject が存在しない場合にのみ使用します。追加の独立したディメンションではありません。 例: false取得または入力方法: 旧フィールド名との互換用です。groupByProject を優先して使用してください。 |
|
| isServiceSub | boolean | 互換用のブールスイッチ。groupBy/group_by がない場合にのみ有効です。デフォルトは false です。 例: false取得または入力方法: 旧連携で env+version ごとにサービスを分割する必要がある場合は true を使用します。 |
|
| search | string | オプション。先頭と末尾の空白を除去した後、service の正規表現 .*入力.* に組み立てます。純粋なリテラル検索ではなく、正規表現の特殊文字は業務に応じてエスケープする必要があります。filters と重ねて適用されます。 例: checkout取得または入力方法: サービスノードの name または data.service から実際の名称断片を取得します。 |
|
| serviceMapList | boolean | 履歴パラメータ。現在のコントローラでは使用されず、ページネーションされたリストやファイルを追加で返すことはありません。 例: false取得または入力方法: 旧クライアントとの互換性を維持します。新しいエクスポートロジックは services/maps を直接読み取ります。 |
|
| showFullChain | boolean | デフォルトは false。完全なチェーンを表示するスイッチです。showOnlyMatches と同時に指定でき、実際のサービスマップは下流バージョンの実装によって決まります。 例: false取得または入力方法: ヒットしたノードが属する完全な連結成分が必要な場合は true を使用します。 |
|
| showOnlyMatches | boolean | デフォルトは false。一致のみのモードスイッチです。showFullChain とは独立して転送され、同時に true の場合は Full Chain のセマンティクスで解釈されます。 例: false取得または入力方法: 検索/フィルタでヒットしたノードのみが必要な場合は true を使用します。 |
|
| start | integer | Y | 必須の開始ミリ秒整数。end より小さい必要があります。署名 timestamp は別途現在の Unix 秒を使用します。 例: 1785427200000取得または入力方法: 実際の収集データウィンドウの開始点を Unix ミリ秒に変換します(例: JavaScript Date.getTime())。 |
| workspaceUUID | string | Y | 必須の単一ワークスペース UUID。* やカンマで複数の UUID を連結することはサポートされません。このサイトの External はサイトレベルの資格情報であり、通常メンバーの OpenAPI Key で対象ワークスペースを決定するものではありません。 例: wksp_example001取得または入力方法: ワークスペース一覧 の content.data[].uuid からアクティブなワークスペースを取得します。 |
パラメータ補足説明¶
クエリと認証¶
workspaceUUID は毎回 1 つのワークスペースを指定し、単一のワークスペース ID の代わりに * や複数の UUID を使用することはサポートされません。
start、end はミリ秒タイムスタンプです。署名ヘッダー X-Df-Timestamp は現在の秒タイムスタンプです。
External API AK/SK 署名を使用し、読み取り権限を持つアカウントから呼び出せます。ワークスペース OpenAPI の DF-API-KEY で代替することはできません。
署名バージョンは X-Df-SVersion: v20240417 です。リクエストごとに最終パスとクエリ文字列に基づいて署名を再生成します。
全ワークスペースをクエリする場合は centralService、search、制限的な filters を渡しません。コンソールの単一サービス上流/下流ビューをそのまま全ワークスペースのサービスマップとして扱うことはできません。
複数のワークスペースは同じ時間範囲と groupBy の基準を使用する必要があります。本 API には呼び出しエッジのページネーションやファイルダウンロード機能はありません。
レスポンスフィールド¶
| フィールド | 説明 |
|---|---|
content.services |
サービスノードのリスト。ノード統計データは data 内にあります |
content.maps |
有向呼び出しエッジのリスト。source が target を呼び出します |
services[].workspace_uuid |
ノードが属するワークスペース。返却時に保持する必要があります |
maps[].source_workspace_uuid / target_workspace_uuid |
呼び出しエッジ両端が属するワークスペース。サービス名だけでノードを区別することはできません |
services[].id、maps[].source_id / target_id |
ノードとエッジ端点の関連付け識別子。関連付けと重複排除の際はワークスペースの識別情報およびグループ化ディメンションを保持します |
maps[].total_count |
選択した時間範囲内のこの呼び出しエッジのリクエスト数。サービスノードの総リクエスト数とは同じ統計範囲ではありません |
maps[].avg_per_second、error_count、error_rate |
1 秒あたりの平均リクエスト数、エラー数、エラー比率。error_rate=0.01 は 1% を表します |
maps[].avg_resp_time、p50、p75、p90、p95、p99 |
呼び出しエッジの平均所要時間と所要時間のパーセンタイル。レスポンス例は元の数値を保持します |
以下のレスポンス例は、テスト環境の成功レスポンスにある接続された 2 つのノードと 1 つの呼び出しエッジに基づいています。選択したレコードのフィールドと統計値を保持しており、ワークスペース、サービス、ノード ID、traceId はマスクされています。
フィールドはバージョン、サービスタイプ、グループ化方法によって変化します。たとえば例では最初のノードのみが data.apdex を含みます。フィールドの欠落はゼロ値を意味しません。
エッジ端点が services に現れない場合があります。その場合は maps 内の端点情報を保持し、呼び出しエッジを破棄しないでください。
HTTP とビジネスステータスがいずれも成功し、構造が正常な場合、空の services、maps はその時間範囲にサービスマップデータがないことを表します。失敗または構造欠落を空の結果として扱うことはできません。
複数のワークスペースを集計する際は、元の JSON、失敗したワークスペース、traceId を保持します。同じ呼び出しエッジが重複して出現する可能性があるため、重複エッジのリクエスト数を直接合算したり P99 を平均したりしないでください。
フィルタ条件¶
filters の例は次のとおりです:
{
"tags": [
{
"name": "__tags.__isError.keyword",
"value": [
"true"
],
"operation": "=",
"condition": "and"
},
{
"condition": "and",
"name": "__tags.__serviceName",
"operation": "=~",
"value": [
".*04.*"
]
}
]
}
リクエスト例¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 対象サイトのアドレスおよび管理者が割り当てた External API AK/SK に置き換えます。
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'GET'
path = '/api/v1/tracing/service_map_v2'
query = {'workspaceUUID': 'wksp_example001', 'start': 1785427200000, 'end': 1785430800000, 'groupBy': 'project,env,version'}
data = None
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
レスポンス¶
HTTP 200、application/json の標準 External エンベロープで、データは content にあります。本モジュールは OpenAPI declaration を自動追加せず、content.pageInfo をトップレベルに昇格させることもありません。レスポンスの統計フィールドは実際の下流バージョン/データによって変化します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | サービスマップ JSON オブジェクト。ページネーションせず、OpenAPI 宣言を自動追加しません。 |
| content.services | オブジェクト配列 | サービスノード。正常でデータがない場合は [] です。すべてのエッジ端点を含んでいない場合があります。 |
| content.maps | オブジェクト配列 | 有向呼び出しエッジ。source が target を呼び出します。正常でデータがない場合は [] です。 |
| content.services[].id | string | ノードの識別情報。ワークスペースとグループ化ディメンションを組み合わせて関連付け、サービス名だけで重複排除しません。 |
| content.services[].name | string | ノードのサービス名。 |
| content.services[].alias | string | オプションの表示エイリアス。 |
| content.services[].type | string | オプションのサービスタイプ表示値。 |
| content.services[].workspace_uuid | string | ノードが属するワークスペース UUID。 |
| content.services[].workspace_name | string | Studio が UUID に基づいて補完したワークスペース名。見つからない場合は空になることがあります。 |
| content.services[].project | string | グループ化/収集の project。空または省略される場合があります。 |
| content.services[].cluster_name_k8s | string | グループ化/収集の K8s クラスタ名。空または省略される場合があります。 |
| content.services[].env | string | オプションの環境グループ化ディメンション。 |
| content.services[].version | string | オプションのバージョングループ化ディメンション。 |
| content.services[].filter_matched | boolean | オプションのフィルタ条件一致フラグ。 |
| content.services[].data | object | このノードの統計と元の識別タグ。エンジン/グループ化/サービスタイプに応じて拡張され、すべてのキーが存在する必要はありません。 |
| content.services[].data.key | string | エンジン統計のグループキー。 |
| content.services[].data.service | string | 実際のサービス名。 |
| content.services[].data.workspace_uuid | string | 統計の帰属ワークスペース。 |
| content.services[].data.source_type | string | 収集ソースタイプ(例: web/db など)。 |
| content.services[].data.language | string | オプションの SDK 言語。 |
| content.services[].data.project | string | オプションの project。 |
| content.services[].data.cluster_name_k8s | string | オプションのクラスタ名。 |
| content.services[].data.env | string | オプションの環境。 |
| content.services[].data.version | string | オプションのバージョン。 |
| content.services[].data.total_count | integer | 選択したウィンドウの総リクエスト数。 |
| content.services[].data.avg_per_second | number | 1 秒あたりの平均リクエスト数(req/s)。 |
| content.services[].data.error_count | integer | エラーリクエスト数。 |
| content.services[].data.error_rate | number | エラー比率。0.01 は 1% を表します。 |
| content.services[].data.avg_resp_time | number | 平均レスポンス時間(マイクロ秒)。 |
| content.services[].data.sum_resp_time | number | 累計レスポンス時間(マイクロ秒)。 |
| content.services[].data.max_duration | number | 最大レスポンス時間(マイクロ秒)。 |
| content.services[].data.apdex | number | オプションの Apdex 指標。欠落は 0 を意味しません。 |
| content.services[].data.p50 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.services[].data.p75 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.services[].data.p90 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.services[].data.p95 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.services[].data.p99 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.maps[].source | string | source サービス名。 |
| content.maps[].source_id | string | source ノードの識別情報。 |
| content.maps[].source_alias | string | オプションの表示エイリアス。 |
| content.maps[].source_workspace_uuid | string | source が属するワークスペース UUID。エッジを関連付ける際に必ず保持します。 |
| content.maps[].source_workspace_name | string | Studio が補完したワークスペース名。見つからない場合は空です。 |
| content.maps[].source_project | string | オプションの project ディメンション。 |
| content.maps[].source_cluster_name_k8s | string | オプションの K8s クラスタディメンション。 |
| content.maps[].source_env | string | オプションの環境ディメンション。 |
| content.maps[].source_version | string | オプションのバージョンディメンション。 |
| content.maps[].target | string | target サービス名。 |
| content.maps[].target_id | string | target ノードの識別情報。 |
| content.maps[].target_alias | string | オプションの表示エイリアス。 |
| content.maps[].target_workspace_uuid | string | target が属するワークスペース UUID。エッジを関連付ける際に必ず保持します。 |
| content.maps[].target_workspace_name | string | Studio が補完したワークスペース名。見つからない場合は空です。 |
| content.maps[].target_project | string | オプションの project ディメンション。 |
| content.maps[].target_cluster_name_k8s | string | オプションの K8s クラスタディメンション。 |
| content.maps[].target_env | string | オプションの環境ディメンション。 |
| content.maps[].target_version | string | オプションのバージョンディメンション。 |
| content.maps[].total_count | integer | 選択したウィンドウの総リクエスト数。 |
| content.maps[].avg_per_second | number | 1 秒あたりの平均リクエスト数(req/s)。 |
| content.maps[].error_count | integer | エラーリクエスト数。 |
| content.maps[].error_rate | number | エラー比率。0.01 は 1% を表します。 |
| content.maps[].avg_resp_time | number | 平均レスポンス時間(マイクロ秒)。 |
| content.maps[].sum_resp_time | number | 累計レスポンス時間(マイクロ秒)。 |
| content.maps[].p50 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.maps[].p75 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.maps[].p90 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.maps[].p95 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.maps[].p99 | number | レスポンス時間のパーセンタイル(マイクロ秒)。クロスワークスペース/サービスのパーセンタイル値を直接平均することはできません。 |
| content.services[].その他のキー | JSON 値 | 下流がバージョン/グループ化に応じて拡張するノード情報。実際のキーに従って解釈し、欠落フィールドをゼロで補完してはいけません。 |
| content.maps[].その他のキー | JSON 値 | 下流が拡張するエッジ情報。クロスワークスペースのエクスポート検証に備えて元の JSON を保持します。 |
{
"code": 200,
"content": {
"services": [
{
"alias": "demo-web",
"cluster_name_k8s": "",
"data": {
"apdex": 0.9994428969359331,
"avg_per_second": 0.7255555555555555,
"avg_resp_time": 104885.94027565084,
"cluster_name_k8s": "",
"env": "",
"error_count": 13,
"error_rate": 0.0049770290964777945,
"key": "demo-web",
"language": "",
"max_duration": 3819430,
"p50": 108049,
"p75": 134638,
"p90": 174617,
"p95": 245331,
"p99": 680374,
"project": "",
"service": "demo-web",
"source_type": "web",
"sum_resp_time": 273962076,
"total_count": 2612,
"version": "",
"workspace_uuid": "wksp_example_1"
},
"filter_matched": true,
"id": "node_demo_web",
"name": "demo-web",
"project": "",
"type": "web",
"workspace_name": "示例空间",
"workspace_uuid": "wksp_example_1"
},
{
"alias": "demo-db",
"cluster_name_k8s": "",
"data": {
"avg_per_second": 3.873611111111111,
"avg_resp_time": 34123.73811401936,
"cluster_name_k8s": "",
"env": "",
"error_count": 3,
"error_rate": 0.00021513087128002868,
"key": "demo-db",
"language": "",
"max_duration": 5601590,
"p50": 1086,
"p75": 1686,
"p90": 18220,
"p95": 185415,
"p99": 591486,
"project": "",
"service": "demo-db",
"source_type": "db",
"sum_resp_time": 475855528,
"total_count": 13945,
"version": "",
"workspace_uuid": "wksp_example_1"
},
"filter_matched": true,
"id": "node_demo_db",
"name": "demo-db",
"project": "",
"type": "db",
"workspace_name": "示例空间",
"workspace_uuid": "wksp_example_1"
}
],
"maps": [
{
"avg_per_second": 0.0725,
"avg_resp_time": 1134.478927203065,
"error_count": 0,
"error_rate": 0,
"p50": 267.77212581584365,
"p75": 1064.416823688738,
"p90": 1901.1261103999313,
"p95": 6064.699952926481,
"p99": 10831.996616037464,
"source": "demo-web",
"source_alias": "demo-web",
"source_cluster_name_k8s": "",
"source_id": "node_demo_web",
"source_project": "",
"source_workspace_name": "示例空间",
"source_workspace_uuid": "wksp_example_1",
"sum_resp_time": 296099,
"target": "demo-db",
"target_alias": "demo-db",
"target_cluster_name_k8s": "",
"target_id": "node_demo_db",
"target_project": "",
"target_workspace_name": "示例空间",
"target_workspace_uuid": "wksp_example_1",
"total_count": 261
}
]
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 422 | ft.KodoAPMSummaryRowBudgetExceeded | サービス統計集計のスキャン予算超過 | APM サービスサマリーデータ量が処理上限を超えています。時間範囲を縮小して再試行してください。 | 時間ウィンドウを縮小してください。pageSize を小さくしても、全サービス集計の予算は減りません。 |
| 429 | ft.KodoServerOverloaded | クエリサービスが過負荷またはビジー | 現在のリクエスト頻度が高すぎます。しばらくしてから再試行してください。 | バックオフ間隔で再試行し、同時クエリ数を減らしてください。 |
| 406 | ft.KodoRequestDeadlineExceeded | クエリ実行がバックエンドの許容時間を超過 | データクエリがタイムアウトしました。原因として、データ量が多すぎる、ネットワーク遅延、サーバー負荷が高すぎるなどが考えられます。次の方法で解決できます: 1. フィルタ条件を追加するか時間範囲を縮小してから、再度クエリを実行します。 2. しばらく待ってから、再度クエリを試行します。 |
時間範囲を縮小し、フィルタ条件を追加してから再試行してください。 |
| 406 | ft.KodoTooManyRows | クエリデータ量がバックエンドの制限を超過 | クエリ対象のデータ量が最大件数制限を超えています。フィルタ条件を追加するか時間範囲を縮小してから、再度クエリを実行してください。 | 時間範囲を縮小するか、一致するサービスを減らしてから再試行してください。 |
| 406 | ft.KodoInvalidRegexPattern | 使用した正規表現フィルタ式が無効 | 指定された正規表現パターンが無効です | 正規表現を修正するか、明確なサービス名の集合を使用してください。 |
| 500 | ft.InternalServerError | filters JSON/条件構造のエラー、サービスマップ下流のタイムアウト/通常の 5xx、または返却されたノード/エッジの識別フィールドが不完全でフォーマット例外が発生 | 内部エラー | traceId と実際のフィルタを保持し、ウィンドウを縮小して限定的に再試行してください。失敗または構造欠落を空のサービスマップとして扱うことはできません。 |