コンテンツにスキップ

取得



GET /api/v1/service_manage/performance/get

概要

現在のワークスペース内のサービスについて、指定した期間のパフォーマンス統計を取得します。

呼び出し前の準備と使用手順

まずサービスパフォーマンス一覧から service 名を取得し、そのまま serviceName に入力します。統計範囲を一覧と同じ start、end にすると比較しやすくなります。この API は最初に一致した統計項目を返すため、content を直接読み取ります。データがない場合、content は空のオブジェクトです。サービスの関連ステータスは同期クエリで取得します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

クエリリクエストパラメータ

パラメータ名 型 必須 説明
end integer Y クエリ終了時刻(Unix ミリ秒)。start と同じ時間基準を使用します。
例: 1785430800000
取得または入力方法: クエリ終了時点の Unix ミリ秒整数(例: JavaScript の Date.getTime() の結果)を取得します。
serviceName string Y サービス名。名称値と sman_ で始まるサービス設定 UUID を区別します。
空文字列を許可: False
null を許可: False
例: checkout-api
取得または入力方法: サービスパフォーマンス一覧の content.buckets[].service から元のサービス名を取得します。また、サービス設定一覧からサービス名を取得することもできます。
start integer Y クエリ開始時刻(Unix ミリ秒)。実際に必要な統計期間を構成するには、end と組み合わせることを推奨します。
例: 1785427200000
取得または入力方法: コンソールの時間セレクターまたは業務記録に基づいてクエリ開始時点を取得し、Unix ミリ秒の整数に変換します。サンプルの時刻はご自身のクエリ期間に置き換えてください。

パラメータの補足説明

レスポンス時間の元の値はマイクロ秒を使用し、エラー率は 0 から 1 の比率を使用します。統計内容は収集ディメンションによって変化する場合があります。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/service_manage/performance/get' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode start=1785427200000 \
  --data-urlencode end=1785430800000 \
  --data-urlencode serviceName=checkout-api

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。

フィールド 型 説明
content.key string グループ化されたサービス名。通常は service と同じです。
content.service string 収集データ内のサービス名。単一サービスを照会する際の serviceName でもあります。
content.source_type string 収集されたサービスのソース種別。
content.type string 互換フィールド。source_type と同じです。
content.version string サービスバージョン。この統計ディメンションが存在する場合に返されます。
content.env string サービス環境。この統計ディメンションが存在する場合に返されます。
content.total_count integer 統計期間内のリクエスト数。
content.avg_per_second number 1 秒あたりの平均リクエスト数。単位は req/s。
content.avg_resp_time number 平均レスポンス時間。単位はマイクロ秒で、ミリ秒に換算する場合は 1000 で割ります。
content.sum_resp_time number リクエストのレスポンス時間の累計。単位はマイクロ秒。
content.max_duration number 最長のリクエストレスポンス時間。単位はマイクロ秒。
content.p50 number レスポンス時間の第 50 パーセンタイル。単位はマイクロ秒。
content.p75 number レスポンス時間の第 75 パーセンタイル。単位はマイクロ秒。
content.p90 number レスポンス時間の第 90 パーセンタイル。単位はマイクロ秒。
content.p95 number レスポンス時間の第 95 パーセンタイル。単位はマイクロ秒。
content.p99 number レスポンス時間の第 99 パーセンタイル。単位はマイクロ秒。
content.error_count integer エラーリクエスト数。
content.error_rate number エラー率。0 から 1 の値で、パーセント表示する場合は 100 を掛けます。
content.apdex number または string バックエンドから提供される場合に返される Apdex 満足度。
content.serviceCatelog object 登録済みサービスの TOML サービス設定を変換して得られるオブジェクト。スペルは serviceCatelog のまま保持します。構造は、サービス設定の作成の serviceCatelog TOML 文字列を解析した後の構造と一致します。作成パラメータは引き続き TOML 文字列であり、フィールドの意味と入力元については同ページを参照してください。未登録の場合は空のオブジェクトです。
content.serviceCatelog.Team.team string 設定が存在する場合は担当チーム名です。その他のサービス設定フィールドは、サービス設定の詳細と合わせて読み取ることができます。
content.checkerInfo array<object> 関連するモニターの一覧。
content.checkerInfo[].name string モニター名。
content.checkerInfo[].uuid string モニター UUID。
content.checkerInfo[].type string モニター種別。
content.dfStatus string サービスの現在のイベントステータス(ok、critical など)。ステータス記録がない場合は ok です。
content.__docid string サービスのステータスに対応するイベントドキュメント ID。対応するイベントがない場合は空文字列です。
content.isFavorite integer または null 現在の呼び出し元の識別情報におけるお気に入りフラグ。登録済みサービスでは 0 または 1、対応するサービス設定がない場合は null になることがあります。
content.uuid string 登録済みのサービス設定 UUID。未登録サービスの場合は空文字列になることがあります。
content.language string 登録された収集 SDK の言語。未登録の場合は空になることがあります。
content.declaration object または null 空でない統計結果に付加されるワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "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",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

一致するデータがない場合

{
  "code": 200,
  "content": {},
  "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. しばらく待ってから、再度クエリを試行します。
時間枠を縮小し、serviceName を確認してから再試行します。失敗が続く場合は traceId を提供してください。
406 ft.KodoTooManyRows クエリデータ量がバックエンドの制限を超えています クエリ対象のデータ量が最大数量制限を超えています。フィルター条件を追加するか時間範囲を縮小してから、再度クエリを実行してください。 時間枠を縮小し、serviceName を確認してから再試行します。失敗が続く場合は traceId を提供してください。

フィードバック

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