費用分析APIリファレンス
GIIPプラットフォームで集計されたクラウドおよびインフラのコストデータと、AI最適化提案を照会するためのAPI詳細仕様です.
📋 概要
費用分析APIは、複数のクラウド(Azure、AWSなど)とオンプレミスリソースのコストデータを統合して提供します。財務システムとの連携や、自動レポート作成のために活用できます。
⚠️ 実装状況(最初に確認) 以下の汎用
/cost/*エンドポイント(/cost/summary,/cost/breakdown,/cost/recommendations,https://api.giip.io/v3,x-giip-akヘッダー)は 計画中/未実装です — まだ呼び出さないでください。 Azure の費用には、実際にデプロイ済みの APIazureCost/azureCostServers(https://giipfaw.azurewebsites.net/api、認証ヘッダーx-api-key)を使用してください。コピーして実行できるクイックスタートは Azure 費用ガイド の「🤖 AI/API クイックスタート」セクションにあります。
✅ 実装済み: Azure 費用 API (x-api-key)
| API | Method | URL |
|---|---|---|
| サーバー一覧 | GET | https://giipfaw.azurewebsites.net/api/azureCostServers?csn={csn} |
| 費用詳細 | GET | https://giipfaw.azurewebsites.net/api/azureCost?csn={csn}&lssn={lssn} |
認証は x-api-key ヘッダーのみで渡します(キーを URL・本文に入れない)。リクエスト/レスポンス契約、エラー表、cURL/PowerShell/Python の例は Azure 費用ガイド にあります。
🔍 主要なエンドポイント (🚧 計画中/未実装)
以下の 3 つのエンドポイントは計画中の汎用費用 API で、まだ実装されていません。設計参考としてのみ残しており、実際の照会には上記の Azure 費用 API を使用してください。
1. 日次・月次の費用要約照会 — 🚧 計画中/未実装
特定の期間に発生した全体費用の合計を取得します。
- URL:
GET /cost/summary - 主なパラメータ:
date_from,date_to: 照会期間の設定prj_isn(Integer): 特定プロジェクトの費用のみ照会
- レスポンスデータ: 合計金額、通貨(Currency)、前日比の変動率など
2. 資産別の費用内訳の照会 — 🚧 計画中/未実装
どのサーバーやデータベースで最も多くの費用が発生しているかを分析します。
- URL:
GET /cost/breakdown - レスポンスデータ: 資産タイプ別(VM、DB、Networkなど)の費用リスト
3. AI費用最適化提案の照会 — 🚧 計画中/未実装
AIが分析したリソース調整(Rightsizing)による費用削減の見積もりを照会します。
- URL:
GET /cost/recommendations - レスポンスデータ: 対象資産、現在の仕様、推奨される仕様、予想削減額
🛠️ 活用例 (cURL) — Azure 費用 API(実装済み)
# キーを URL/本文に入れず、環境変数のみを使用
export GIIP_CSN=47
export GIIP_API_KEY=***your_key***
# サーバー一覧 + 既定サーバー
curl -s "https://giipfaw.azurewebsites.net/api/azureCostServers?csn=${GIIP_CSN}" \
-H "x-api-key: ${GIIP_API_KEY}"
# 単一サーバーの費用詳細
curl -s "https://giipfaw.azurewebsites.net/api/azureCost?csn=${GIIP_CSN}&lssn=71197" \
-H "x-api-key: ${GIIP_API_KEY}"
🛡️ Sk3(高性能ロギング)の活用
費用データ収集のデータ整合性検証と詳細な監査ログが必要な場合は、 giipApiSk3 エンドポイントを推奨します。
- エンドポイント:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - 独自の利点: 自動エラーロギング、呼び出し元のメタデータ(IPなど)の追跡、
jsondata置換機能による複雑な照会条件の最適化。 - 活用チップ: 大規模なインフラ費用分析の際、
textコマンドとjsondataを組み合わせることで、クエリの整合性を保証しながら呼び出すことができます。
トラブルシューティング
| 症状 | 原因 | 解決 |
|---|---|---|
| 401 認証エラーが発生するか、空のレスポンスが返される | x-api-key ヘッダーがないか、誤ったキーが入力されている | リクエストヘッダーの x-api-key に有効なキーが設定されているか確認します(Azure 費用 API は x-giip-ak ではなく x-api-key を使用) |
レスポンスの RstVal が 200 以外のコードを返す | パラメータまたは照会条件が誤っている | API結果コードガイドを参照して原因コードを確認し、パラメータを修正します |
Sk3 の text コマンド呼び出しが失敗する | text コマンドのシグネチャが誤っている | text コマンドと jsondata の組み合わせ形式が正しいか確認します |
jsondata 送信時に JSON パースエラーが発生する | jsondata 内の引用符が正しくエスケープされていない | jsondata の値の引用符を正しくエスケープして再送します |
バージョン: 1.1
最終更新日: 2026-04-11
ソースファイル: giipv3/public/help/api-cost.ja.md
関連ドキュメント: