从 EA 预留实例使用量详细信息 API 迁移

以前使用 Enterprise Reporting consumption.azure.com API 获取预留实例使用情况详细信息的 EA 客户需要迁移到等效的 Azure 资源管理器 API。 以下说明可帮助你迁移和讨论旧 API 与新 API 之间的任何协定差异。

注意

所有Azure企业报告 API 都已停用。 应尽快迁移到Microsoft 成本管理 API接口

向服务主体分配权限以调用 API

在调用 API 之前,需要配置具有正确权限的服务主体。 使用服务主体调用 API。 有关详细信息,请参阅向成本管理 API 分配权限

调用预留实例 API 获取使用量详细信息

Microsoft不会更新旧的基于同步的预留详细信息 API。 建议你在迁移过程中切换为更新的支持 SPN 的异步 API 调用模式。 异步请求可更好地处理大量数据,并减少超时错误。

支持的请求

在调用新的异步预留详细信息 API 时,请使用以下请求 URI。 使用你的注册号码作为 billingAccountId。 可以使用以下范围调用 API:

注册:providers/Microsoft.Billing/billingAccounts/{billingAccountId}

按计费帐户 ID 生成报表

生成预留详细信息报告的示例请求

POST https://management.chinacloudapi.cn/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport?startDate={startDate}&endDate={endDate}&api-version=2023-11-01 

POST 请求返回一个链接,以便轮询报告生成状态,具体参见以下响应示例:

示例响应

状态代码 202

Location: https://management.chinacloudapi.cn/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb?api-version=2023-11-01
Retry-After: 60

状态代码 200

{
  "status": "Completed",
  "properties": {
    "reportUrl": "https://storage.blob.core.chinacloudapi.cn/details/20200911/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2020-09-12T02:56:55.5021869Z"
  }
}

轮询报告生成状态的示例请求

GET https://management.chinacloudapi.cn/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/reservationDetailsOperationResults/{operationId}?api-version=2023-11-01 

示例轮询响应

{
  "status": "Completed",
  "properties": {
    "reportUrl": "https://storage.blob.core.chinacloudapi.cn/details/20200911/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2020-09-12T02:56:55.5021869Z"
  }
}

响应正文更改

以下信息是旧版基于同步的预留详细信息 API 的响应示例。

旧响应:

{
    "reservationOrderId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "reservationId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
    "usageDate": "2018-02-01T00:00:00",
    "skuName": "Standard_F2s",
    "instanceId": "/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourcegroups/resourcegroup1/providers/microsoft.compute/virtualmachines/VM1",
    "totalReservedQuantity": 18.000000000000000,
    "reservedHours": 432.000000000000000,
    "usedHours": 400.000000000000000
}

新响应:

新 API 可为你创建 CSV 文件。 请参阅以下文件字段。

旧属性 新属性 说明
实例弹性组 新的实例大小灵活性属性。
实例灵活性比率 (InstanceFlexibilityRatio) 新的实例大小灵活性属性。
instanceId InstanceName
种类 这是一个新属性。 值为 NoneReservationIncludedQuantity
预订ID 预订ID
预订订单编号 ReservationOrderId
预留时间 预留时间
SKU名称 SkuName
总预留数量 总保留数量
usageDate 使用日期
使用小时数 已用工时