一覧取得¶
GET /api/v1/service_manage/performance/list
概要¶
現在の API Key が所属するワークスペースのサービスパフォーマンス統計を、時間ウィンドウごとに一覧表示します。
呼び出し前の準備と使用手順¶
まずクエリ時間ウィンドウを決定し、service フィールドと収集タグを使用してフィルター条件を構成します。デフォルトでは p99 の降順で並べ替え、現在の呼び出し元 ID がお気に入りに登録したサービスを先頭に配置します。order を明示的に指定した場合は、その並び順でページネーションします。デフォルトは pageIndex=1、pageSize=50 です。content.pageInfo.totalCount と現在のページの件数に基づいて、続行するかどうかを判断します。content.buckets[].service を使用してサービスパフォーマンス詳細をリクエストします。返される max_* 値は、そのウィンドウ内のすべてのサービスから取得されます。filters を追加した後も、これらのグローバルな比較上限は保持されます。インデックスまたは統計データがない場合、max_* は省略されることがあります。loading=true は、付加的なサービス状態がまだ読み込み中である可能性があることを示します。後で再リクエストできます。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| end | integer | Y | クエリ終了時刻(Unix ミリ秒)。start と同じ時間基準を使用します。 例: 1785430800000取得または入力方法: クエリ終了時点の Unix ミリ秒整数を取得します。たとえば JavaScript の Date.getTime() の結果です。 |
| filters | json | フィルター JSON。tags 配列を含むオブジェクト、または条件配列を使用できます。name は収集フィールドで、たとえば service、env、version です。operation または互換性のある op で演算を指定し、value は配列、condition または互換性のある logic で and/or を指定します(デフォルトは and)。子 filters 配列はネストした条件を構成します。 例: {"tags": [{"name": "service", "operation": "in", "value": ["checkout-api"], "condition": "and"}]}取得または入力方法: サービスパフォーマンス一覧の返却項目からサービス名、環境、バージョンを選択するか、実際の収集タグフィールドを使用します。--data-urlencode で JSON 文字列を渡します。 |
|
| order | string | デフォルトは p99 の降順です。使用可能なフィールドは key、total_count、avg_resp_time、avg_per_second、error_count、error_rate、sum_resp_time、max_duration、p50、p75、p90、p95、p99 です。配列内の最初のオブジェクトのみを使用します。 例: [{"p99":"desc"}]取得または入力方法: 使用可能なフィールドから 1 つ選択し、必要に応じて asc または desc を指定します。単一要素の JSON 配列文字列を渡します。 |
|
| pageIndex | integer | ページ番号。デフォルトは 1 です。 null を許可: False $minValue: 1 例: 1取得または入力方法: 1 から開始し、後続のリクエストではページ番号を増やし、フィルターと時間ウィンドウを一致させます。 |
|
| pageSize | integer | 1 ページあたりの件数。デフォルトは 50 です。 null を許可: False $maxValue: 100 $minValue: 1 例: 50取得または入力方法: 必要に応じて 1 から 100 の整数を入力します。 |
|
| start | integer | Y | クエリ開始時刻(Unix ミリ秒)。end と組み合わせて、実際に必要な統計ウィンドウを構成することを推奨します。 例: 1785427200000取得または入力方法: コンソールの時間セレクターまたは業務記録からクエリ開始時点を取得し、Unix ミリ秒整数に変換します。例の時刻は自分のクエリ時間ウィンドウに置き換えてください。 |
パラメータの補足説明¶
filters の例は元の JSON 構造で渡し、URL エンコードを行います。order は空でない JSON 配列である必要があり、先頭項目が並べ替えオブジェクトです。誤った形状や、name、operation、value のいずれかが欠けたフィルター項目は、汎用的な内部エラーを引き起こす可能性があります。リクエスト前に上記の構造に従って構成してください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/service_manage/performance/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode start=1785427200000 \
--data-urlencode end=1785430800000 \
--data-urlencode 'filters={"tags":[{"name":"service","operation":"in","value":["checkout-api"],"condition":"and"}]}' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=50
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.max_duration | number | すべてのサービスにおける最大応答時間の上限(マイクロ秒)。 |
| content.max_total_count | integer | すべてのサービスの中で最大の総リクエスト数。 |
| content.max_per_second | number | すべてのサービスの中で最大の 1 秒あたりのリクエスト数(req/s)。 |
| content.max_avg_duration | number | すべてのサービスの中で最大の平均応答時間(マイクロ秒)。 |
| content.max_sum_duration | number | すべてのサービスの中で最大の累計応答時間(マイクロ秒)。 |
| content.max_p50 | number | すべてのサービスの中で最大の P50 応答時間(マイクロ秒)。 |
| content.max_p75 | number | すべてのサービスの中で最大の P75 応答時間(マイクロ秒)。 |
| content.max_p90 | number | すべてのサービスの中で最大の P90 応答時間(マイクロ秒)。 |
| content.max_p95 | number | すべてのサービスの中で最大の P95 応答時間(マイクロ秒)。 |
| content.max_p99 | number | すべてのサービスの中で最大の P99 応答時間(マイクロ秒)。 |
| content.buckets | array<object> |
現在のページのサービス統計。統計フィールドは存在するデータに応じて提供されます。 |
| content.buckets[].key | string | グループ化されたサービス名。通常は service と同じです。 |
| content.buckets[].service | string | 収集データ内のサービス名。単一サービスをクエリする際の serviceName でもあります。 |
| content.buckets[].source_type | string | 収集されたサービスのソースタイプ。 |
| content.buckets[].type | string | 互換フィールド。source_type と同じです。 |
| content.buckets[].version | string | サービスのバージョン。この統計ディメンションが存在する場合に返されます。 |
| content.buckets[].env | string | サービスの環境。この統計ディメンションが存在する場合に返されます。 |
| content.buckets[].total_count | integer | 統計ウィンドウ内のリクエスト数。 |
| content.buckets[].avg_per_second | number | 1 秒あたりの平均リクエスト数(単位: req/s)。 |
| content.buckets[].avg_resp_time | number | 平均応答時間(単位: マイクロ秒)。ミリ秒に換算する場合は 1000 で除算します。 |
| content.buckets[].sum_resp_time | number | リクエスト応答時間の累計(単位: マイクロ秒)。 |
| content.buckets[].max_duration | number | 最長のリクエスト応答時間(単位: マイクロ秒)。 |
| content.buckets[].p50 | number | 応答時間の 50 パーセンタイル(単位: マイクロ秒)。 |
| content.buckets[].p75 | number | 応答時間の 75 パーセンタイル(単位: マイクロ秒)。 |
| content.buckets[].p90 | number | 応答時間の 90 パーセンタイル(単位: マイクロ秒)。 |
| content.buckets[].p95 | number | 応答時間の 95 パーセンタイル(単位: マイクロ秒)。 |
| content.buckets[].p99 | number | 応答時間の 99 パーセンタイル(単位: マイクロ秒)。 |
| content.buckets[].error_count | integer | エラーリクエスト数。 |
| content.buckets[].error_rate | number | エラー率(0 から 1)。パーセント表示にする場合は 100 を乗算します。 |
| content.buckets[].apdex | number または string | バックエンドから提供される場合に返される Apdex 満足度。 |
| content.buckets[].serviceCatelog | object | 登録済みサービスの TOML サービス設定を変換して得られたオブジェクトです。スペルは serviceCatelog のまま保持します。構造は、サービス設定の作成の serviceCatelog TOML 文字列を解析した後の構造と一致します。作成パラメータは引き続き TOML 文字列であり、フィールドの意味と入力元はそのページを参照してください。未登録の場合は空のオブジェクトです。 |
| content.buckets[].serviceCatelog.Team.team | string | 設定が存在する場合は担当チーム名。その他のサービス設定フィールドは、サービス設定の詳細と組み合わせて読み取ることができます。 |
| content.buckets[].checkerInfo | array<object> |
関連付けられたモニターの一覧。 |
| content.buckets[].checkerInfo[].name | string | モニター名。 |
| content.buckets[].checkerInfo[].uuid | string | モニター UUID。 |
| content.buckets[].checkerInfo[].type | string | モニタータイプ。 |
| content.buckets[].dfStatus | string | サービスの現在のイベント状態(例: ok、critical)。状態レコードがない場合は ok です。 |
| content.buckets[].__docid | string | サービス状態に対応するイベントドキュメント ID。対応するイベントがない場合は空文字列です。 |
| content.buckets[].isFavorite | integer または null | 現在の呼び出し元 ID のお気に入りフラグ。登録済みサービスの場合は 0 または 1、対応するサービス設定がない場合は null になることがあります。 |
| content.buckets[].uuid | string | 登録済みサービス設定の UUID。未登録サービスの場合は空文字列になることがあります。 |
| content.buckets[].language | string | 登録された収集 SDK の言語。未登録の場合は空になることがあります。 |
| content.pageInfo | object | ページネーション情報は content 内にあります。 |
| content.pageInfo.pageIndex | integer | 現在のページ番号。 |
| content.pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| content.pageInfo.count | integer | 現在のページの実際の件数。 |
| content.pageInfo.totalCount | integer | 一致するサービスの総数。 |
| content.loading | boolean | 付加状態がまだ非同期で読み込み中かどうか。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"max_duration": 150000,
"max_total_count": 1200,
"max_per_second": 0.333333,
"max_avg_duration": 25000,
"max_sum_duration": 30000000,
"max_p50": 18000,
"max_p75": 25000,
"max_p90": 45000,
"max_p95": 70000,
"max_p99": 120000,
"buckets": [
{
"key": "checkout-api",
"service": "checkout-api",
"source_type": "web",
"type": "web",
"version": "1.0.0",
"env": "production",
"total_count": 1200,
"avg_per_second": 0.333333,
"avg_resp_time": 25000,
"sum_resp_time": 30000000,
"max_duration": 150000,
"p50": 18000,
"p75": 25000,
"p90": 45000,
"p95": 70000,
"p99": 120000,
"error_count": 12,
"error_rate": 0.01,
"serviceCatelog": {},
"checkerInfo": [],
"dfStatus": "ok",
"__docid": "",
"isFavorite": 0,
"uuid": "sman_example",
"language": "python"
}
],
"pageInfo": {
"pageIndex": 1,
"pageSize": 50,
"count": 1,
"totalCount": 1
},
"loading": false,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
一致するトレースデータがない場合、一覧は空の buckets を返し、単一サービスは空のオブジェクトを返します。通常、「サービスが存在しません」というエラーは返されません。バックエンドから返されるその他の 4xx クエリエラーは、実際の errorCode と message に従って返されます。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 422 | ft.KodoAPMSummaryRowBudgetExceeded | サービス統計集計のスキャン予算を超過 | APM サービス集計データ量が処理上限を超えています。時間範囲を縮小して再試行してください。 | 時間ウィンドウを縮小してください。pageSize を小さくしても、すべてのサービスの集計予算は減りません。 |
| 429 | ft.KodoServerOverloaded | クエリサービスが過負荷またはビジー | 現在のリクエスト頻度が高すぎます。しばらくしてから再試行してください。 | バックオフ間隔で再試行し、同時クエリ数を減らしてください。 |
| 500 | ft.InternalServerError | 統計サービスが利用不可、接続タイムアウト、またはその他の透過されていない内部クエリ例外 | 内部エラー | しばらくしてから再試行するか、時間ウィンドウを縮小してください。継続的に失敗する場合は traceId とリクエストパラメータを提供してください。 |
| 406 | ft.KodoRequestDeadlineExceeded | クエリ実行がバックエンドで許容される時間を超過 | データクエリがタイムアウトしました。原因として、データ量が多すぎる、ネットワーク遅延、サーバー負荷が高すぎるなどが考えられます。この問題は次の方法で解決できます: 1. フィルター条件を追加するか時間範囲を縮小してから、再度クエリを実行します。 2. しばらく待ってから、再度クエリを試行します。 |
時間範囲を縮小し、フィルター条件を追加してから再試行してください。 |
| 406 | ft.KodoTooManyRows | クエリデータ量がバックエンドの制限を超過 | クエリ対象のデータ量が最大件数制限を超えています。フィルター条件を追加するか時間範囲を縮小してから、再度クエリを実行してください。 | 時間範囲を縮小するか、一致するサービスを減らしてから再試行してください。 |
| 406 | ft.KodoInvalidRegexPattern | 使用した正規表現フィルター式が無効 | 提供された正規表現パターンが無効です | 正規表現を修正するか、明確なサービス名の集合に変更してください。 |