面向企业协议客户的报告 API 概述
备注
本文仅适用企业协议用户。了解 如何成为企业协议客户。
Azure 企业协议客户可通过 REST 或 JSON API 访问使用量和计费信息。企业管理员需要通过从企业门户生成密钥来启用对 API 的访问权限。获得合约编号和密钥的任何人均可访问 API。
启用通过 API 的数据访问
现在， Azure 企业协议客户可通过 API 访问使用量和计费信息。 企业管理员通过访问密钥控制对 API 的访问权限。企业管理员可以执行企业门户中“报告 API 访问密钥”下的的以下功能：
- 生成主访问密钥和次要访问密钥
- 禁用访问密钥
- 查看访问密钥的开始日期和结束日期
可通过 API 获得的报告
Azure 企业协议客户通过 API 可以获得两个不同的报告：
- 合约摘要 CSV 文件： 此报告包含与本月合约摘要相关的信息。此报告包含的信息和格式与在企业门户的“下载使用量数据”部分获得的“余额和费用”报告相同。
- 使用量和计费详细信息 CSV 文件： 此报告包含与服务使用量和计费相关的详细信息。此报告包含的信息和格式与在企业门户的“下载使用量数据”部分获得的“使用量详细信息”报告相同。
API 详细信息
REST 或 JSON API 用于获取 CSV 文件。可以使用两个不同的 API ：
- GetUsageList API： 提供的 JSON 字符串所列出的月份会提供使用量摘要和详细报告。返回的信息包含调用 GetUsageByMonth API 的 URI。
- GetUsageByMonth API： 此 API 使用户能够下载“合约摘要 CSV” 二进制数组和“使用量和计费详细信息CSV” 二进制数组。
关于技术规范文档和示例代码，请登录企业门户帮助文档查看。
使用量和计费数据的更新频率
- 目前文件每 24 小时更新一次。
- 可能存在长达 3 天的数据延迟。例如，周一的使用量可能会到周四才会在文件中显示。
调用 API 进行 POC 开发
如果你是合作伙伴或开发人员并要访问 API，但还没有签署 Azure 企业协议，则可以使用测试合约 (EnrollmentNumber 100) 和 测试合约访问密钥来调用 API 并查看示例数据。
Azure服务目录
我们在 Blob 上以 CSV 格式发布了所有 Azure 服务的目录。如果你需要为你的系统构建所有 Azure 服务的特选目录，则此目录很有用。该文件每月更新两次，在每月 5 日和 20 日或该日期之前发布。目录 URL： https://azurepricing.blob.core.windows.net/supplemental/Friendly_Service_Names.xlsx
目录列详细信息
| 字段名 | 详细信息 |
|---|---|
| 产品 | 此字段包含服务名称。例如： “ A1 VM (非 Windows) - 中国北部” |
| ResourceGUID | 是标识服务的唯一键。详细使用量 CSV 也包含 ResourceGUID，此字段应该用于在该目录和详细使用量之间进行交叉引用。 |
| 顶级服务分类 | 帮助缩小服务范围。对于具有多个服务类型的服务特别重要，例如： 虚拟机。 |
| 服务类型 | 提供有关服务的第二级详细信息。例如： A1 VM（ 非 Windows） |
| 服务区域 | 这是服务所需的第三级详细信息，此字段有助于将范围缩小到 ResourceGUID 的区域上下文。 |
| 服务资源 | 这是第四级也是最后一级详细信息，此字段有助于将范围缩小到所用的服务资源。将此字段与“服务”、“服务类型”和“服务区域”结合使用可提供完整的服务上下文。例如： “ Azure 存储空间-地理冗余-所有区域-标准 IO - 块 Blob (GB)” 和 “Azure 存储空间-地理冗余-所有区域-标准 IO - 文件(GB)”。这两个示例中的突出显示部分为“服务资源”，请注意服务的其他详细信息没有更改。 |
| 度量单位 | 示例值： 小时、 GB、事件、推送、单位、单位小时、MB、每日单位。 |
| 套餐产品编号 | 当客户在企业协议合约上有资金承诺时应针对定价进行交叉引用的产品编号。 |
| 每单位套餐用量 | 此字段提供 1 个单位的 SKU 中包括的服务数。例如： 当每个 SKU 表示使用 100 小时，虚拟机 SKU 的此值将为 100。 |
| 使用产品编号 | 当客户在企业协议合约上没有资金承诺时应针对定价进行交叉引用的产品编号。 |
| 每单位使用量 | 此字段提供 1 个单位的 SKU 中包括的服务数。例如： 当每个 SKU 表示使用 100 小时，虚拟机 SKU 的此值将为 100。 |
| 报告月份 | 此字段指示运行该服务目录报告的月份。 |