你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Azure 企业报告 API 概述

注意

Microsoft 不再更新 Azure 企业报告 API。 应使用成本管理 API。 要了解详细信息,请参阅从 Azure 企业报告迁移到 Microsoft 成本管理 API 概述

Azure 企业报告 API 使企业 Azure 客户能够以编程方式将消费和计费数据提取到首选的数据分析工具中。 企业客户与 Azure 签订了企业协议 (EA),以达成协商的 Azure 预付款(以前称为货币承诺)并获取自定义 Azure 资源定价的访问权限。

API 所需的所有日期和时间参数都必须表示为组合的协调世界时 (UTC) 值。 API 返回的值以 UTC 格式显示。

实现对 API 的数据访问

  • 生成或检索 API 密钥 - 登录到 Enterprise Portal,并导航到“报告”>“下载使用情况”>“API 访问密钥”,生成或检索 API 密钥。
  • 传递 API 密钥 - 需要为每个调用传递 API 密钥,以便进行身份验证和授权。 以下属性需要是 HTTP 标头
请求标头密钥
授权 用以下格式指定该值:bearer {API_KEY}
示例:bearer eyr....09

基于使用量的 API

可在此处找到为下面所述的 API 提供的 Swagger 终结点,该终结点可以使用 AutoRestSwagger CodeGen 进行简单的 API 自检并生成客户端 SDK。 2014 年 5 月 1 日开始的数据就是通过此 API 提供的。

  • 余额和摘要 - 余额和摘要 API 提供关于余额、新购买、Azure 市场服务费用、调整和超额费用信息的每月摘要。

  • 使用情况详细信息 - 使用情况详细信息 API 提供已耗用量和注册估计费用的日常明细。 结果还包括有关实例、计量和部门信息。 可以按照计费周期或指定的开始日期和结束日期查询 API。

  • 市场应用商店费用 - 市场应用商店费用 API 会返回基于使用情况的市场费用明细(不包括一次性费用),且按指定计费周期的天或开始和结束日期排列。

  • 价目表 - 价目表 API 为给定注册和计费周期的每个计量提供适用的费率。

  • 预留实例详细信息 - 预留实例使用情况 API 返回预留实例购买项的使用情况。 预留实例费用 API 显示进行的计费事务。

数据刷新

在上述所有 API 的响应中将返回 Etag。 Etag 中的更改指示数据已刷新。 在使用相同参数对同一 API 的后续调用中,将使用 http 请求标头中的键“If-None-Match”传递捕获的 Etag。 如果没有进一步刷新数据,则响应状态代码将为“NotModified”且不会返回任何数据。 只要存在 etag 更改,API 就会返回所需时段内的完整数据集。

帮助程序 API

列出计费周期 - 计费周期 API 会以倒序顺序为指定的注册返回具有消耗数据的计费周期列表。 每个周期都有一个属性指向以下 4 个数据集的 API 路由:BalanceSummary、UsageDetails、Marketplace Charge 和 PriceSheet。

API 响应代码

响应状态代码 消息 说明
200 OK 无错误
400 错误的请求 参数无效 – 日期范围、EA 号等。
401 未授权 API 密钥找不到、无效、已过期等。
404 不可用 找不到报表终结点
429 TooManyRequests 请求被限制。 等待 x-ms-ratelimit-microsoft.consumption-retry-after 标头中指定的时间后重试。
500 服务器错误 处理请求时出现异常错误
503 ServiceUnavailable 服务暂时不可用。 等待 Retry-After 标头中指定的时间后重试。