エクスポート¶
GET /api/v1/service_manage/performance/export
概要¶
現在のワークスペースのサービスパフォーマンス統計を CSV として同期的にエクスポートします。
呼び出し前の準備と使用手順¶
エクスポートする時間ウィンドウを指定して GET を発行します。成功時のレスポンスボディは CSV テキストそのものであり、code/content の JSON ラッピングはありません。この API はその時間ウィンドウ内のすべての統計サービスをエクスポートし、リストの filters、order、ページングパラメータは受け付けません。p99 の降順で並びます。列見出しはワークスペースの言語によって変化し、中国語のワークスペースではデフォルトで下表の列順に出力されます。CSV 内の所要時間は換算済みで表示単位が付き、エラー数には割合が含まれます。CSV として解析する前に、HTTP ステータスと Content-Type を確認してください。失敗時のレスポンスが JSON である場合もあります。例では --output でローカルファイル名を指定しています。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| end | integer | Y | クエリ終了時刻(Unix ミリ秒)。start と同じ時間基準を使用します。 例: 1785430800000取得または入力方法: クエリ終了時刻の Unix ミリ秒整数を取得します。たとえば JavaScript の Date.getTime() の結果です。 |
| start | integer | Y | クエリ開始時刻(Unix ミリ秒)。end と組み合わせて実際に必要な統計期間を構成することを推奨します。 例: 1785427200000取得または入力方法: コンソールの時間セレクターまたは業務記録に基づいてクエリ開始時刻を取得し、Unix ミリ秒整数に変換します。例の時刻は各自のクエリ期間に置き換えてください。 |
パラメータ補足¶
データがない場合でもヘッダー行は返されることがあります。この API には固定の Content-Disposition ダウンロードファイル名はありません。CSV では各値が二重引用符で囲まれ、引用符や改行を含む業務テキストはサードパーティの解析に影響する可能性があります。厳密なエスケープ要件がある場合は、JSON リストを使用して CSV を自身でエンコードしてください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/service_manage/performance/export' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode start=1785427200000 \
--data-urlencode end=1785430800000 \
--output service-performance.csv
レスポンス¶
HTTP 200、Content-Type: text/csv。レスポンスボディは CSV テキストです。以下のフィールド表はデフォルトの中国語列について説明します。
| フィールド | 型 | 説明 |
|---|---|---|
| 服务 | string | 収集されたサービス名。 |
| 请求总数 | string | リクエスト総数。 |
| 平均请求数 | string | 平均リクエスト頻度(req/s 付き)。 |
| 平均响应时间 | string | フォーマット済みの平均レスポンス時間(ms などの単位付き)。 |
| P75响应时间 | string | P75 レスポンス時間(表示単位付き)。 |
| P99响应时间 | string | P99 レスポンス時間(表示単位付き)。 |
| 错误数 | string | エラー回数と割合。例: 12(1.0)%。 |
| 团队 | string | サービス設定の Team.team。空の場合があります。 |
| 监控器数量 | string | 関連付けられたモニター数。 |
| 服务状态 | string | サービスの現在の状態。デフォルトは ok です。 |
| 最大响应时间 | string | 最長レスポンス時間(表示単位付き)。 |
| 语言 | string | 登録された収集 SDK の言語。 |
| Apdex满意度 | string | Apdex 値。提供されない場合は空になります。 |
| レスポンスヘッダー | 型 | 説明 |
|---|---|---|
| Content-Type | string | 成功時は text/csv。 |
"服务","请求总数","平均请求数","平均响应时间","P75响应时间","P99响应时间","错误数","团队","监控器数量","服务状态","最大响应时间","语言","Apdex满意度"
"checkout-api","1200","0.33 req/s","25.0 ms","25.0 ms","120.0 ms","12(1.0)%","","0","ok","150.0 ms","python",""
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
成功時は text/csv、認証、パラメータ、クエリの失敗時は共通の JSON エラー構造を使用します。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 422 | ft.KodoAPMSummaryRowBudgetExceeded | サービス統計集計のスキャン予算超過 | APM サービスサマリーデータ量が処理上限を超えています。時間範囲を縮小して再試行してください。 | 時間ウィンドウを縮小してください。pageSize を小さくしても、全サービス集計の予算は減りません。 |
| 429 | ft.KodoServerOverloaded | クエリサービスが過負荷またはビジー状態 | 現在のリクエスト頻度が高すぎます。しばらくしてから再試行してください。 | バックオフ間隔で再試行し、同時クエリ数を減らしてください。 |
| 500 | ft.InternalServerError | 統計サービスが利用不可、接続タイムアウト、またはその他の内部クエリ例外が透過されない | 内部エラー | しばらくしてから再試行するか、時間ウィンドウを縮小してください。失敗が続く場合は traceId とリクエストパラメータを提供してください。 |
| 406 | ft.KodoRequestDeadlineExceeded | クエリの実行がバックエンドで許可された時間を超過 | データクエリがタイムアウトしました。原因として、データ量が多すぎる、ネットワーク遅延、サーバー負荷が高すぎるなどが考えられます。この問題は次の方法で解決できます: 1. フィルター条件を追加するか時間範囲を縮小してから、再度クエリを実行してください。 2. しばらく待ってから、再度クエリを試してください。 |
エクスポート時間ウィンドウを縮小して再試行してください。失敗が続く場合は traceId とリクエストパラメータを提供してください。 |
| 406 | ft.KodoTooManyRows | クエリデータ量がバックエンドの制限を超過 | クエリ対象のデータ量が最大件数制限を超えています。フィルター条件を追加するか、時間範囲を縮小してから再度クエリを実行してください。 | エクスポート時間ウィンドウを縮小して再試行してください。失敗が続く場合は traceId とリクエストパラメータを提供してください。 |