3分钟阅读

费用分析 API 参考指南

用于查询 GIIP 平台汇总的云及基础设施费用数据以及 AI 优化建议的 API 详细规范。

📋 概述

费用分析 API 整合并提供多个云（Azure、AWS 等）及本地资源的费用数据。可用于与财务系统集成或自动生成报告。

⚠️ 实现状态（请先阅读） 下面的通用 /cost/* 端点（/cost/summary、/cost/breakdown、/cost/recommendations，位于 https://api.giip.io/v3，使用 x-giip-ak 头）为计划中/未实现 — 请暂勿调用。 Azure 费用请使用已部署的实际 API azureCost / 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 费用指南。

🔍 核心端点 (🚧 计划中/未实现)

下面三个端点是计划中的通用费用 API，尚未实现。仅作设计参考保留；实际查询请使用上面的 Azure 费用 API。

1. 查询日/月费用摘要 — 🚧 计划中/未实现

获取特定时期内产生的总费用。

URL: GET /cost/summary
主要参数:
- date_from, date_to: 设置查询期间
- prj_isn (Integer): 仅查询特定项目的费用
响应数据: 总金额、货币 (Currency)、较前一日的变动率等

2. 按资产查询费用占比 — 🚧 计划中/未实现

分析哪些服务器或数据库产生的费用最高。

URL: GET /cost/breakdown
响应数据: 按资产类型（虚拟机、数据库、网络等）排列的费用列表

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-api-key`，而非 `x-giip-ak`）
响应中的 `RstVal` 返回非 200 代码	参数或查询条件错误	参考 API 结果代码指南确认原因代码并修正参数
Sk3 的 `text` 命令调用失败	`text` 命令签名错误	确认 `text` 命令与 `jsondata` 的组合格式是否正确
传递 `jsondata` 时出现 JSON 解析错误	`jsondata` 内的引号未正确转义	正确转义 `jsondata` 值中的引号后重新发送

版本: 1.1 最后更新: 2026-04-11 源文件: giipv3/public/help/api-cost.zh-CN.md

相关文档:

API 结果代码指南 (RstVal)