新商业每日评级使用情况 v2 API （beta）

适用于：合作伙伴中心 | 由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心

使用这些 API 以异步方式获取每日计费和未计费的计费使用情况数据。

由于我们努力提供最准确、最及时的信息，你对你的理解和耐心是值得赞赏的。

API 概述

异步 API 是一种新方法，用于快速访问可管理区块中的计费和对帐数据。 它无需在数小时内保持开放连接，并循环访问数百万个事务。

我们使用 辅助密钥 和 异步请求-回复 模式来优化发票和对帐 API，以异步方式交付结果。 API 响应提供一个令牌，用于访问具有所有属性或子集的对帐数据。

可以使用三个新步骤（API 终结点）异步下载使用情况数据。 若要了解详细信息，请阅读以下部分：

使用行项终结点

使用此 API 访问计费或未计费的消耗行项。 它返回一个 202 HTTP 状态和一个带有 URL 的位置标头，你必须定期轮询该 URL，直到收到带有清单 URL 的成功状态。

操作状态终结点

在收到成功状态之前，请定期轮询此 API。 如果请求的数据不可用，API 响应将包含一个重试后标头，指示在发送另一个请求之前应等待多长时间。

清单终结点

此终结点提供一个存储文件夹，可从中下载实际计费数据。 响应拆分或分区文件以优化吞吐量和 I/O 并行度。

序列图

此图描述了下载对帐数据所需的步骤。

用户操作序列

按照以下步骤检索对帐数据。

步骤 1：提交请求

将 POST 请求提交到 API 终结点。

获取未计费的使用情况行项

获取当前或上一个日历月的未计费使用行项。

API 请求

POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/unbilledusage?fragment={fragment}&period={period}?currencyCode={currencyCode}

请求参数

已弃用的请求参数

较新的 API 版本不需要以下 URI 参数：

请求头文件

请参阅本文中 API 的请求标头列表。

请求正文

不适用。

API 响应

HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/811bb8f0-8aca-4807-897c-c15ce50820d6

API 返回 HTTP 状态 202。 根据请求，API 可以返回其他 标准状态。

获取计费的使用情况行项

获取已关闭计费周期的已计费使用情况行项。

API 请求

POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billedusage/invoices/{invoiceId}?fragment={fragment}

请求参数

已弃用的请求参数

较新的 API 版本不需要以下 URI 参数：

请求头文件

请参阅本文中 API 的请求标头列表。

请求正文

不适用。

API 响应

HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e83ab1d4640

API 返回“HTTP 202 已接受”。根据请求 API 可以返回其他 标准状态。

步骤 2：检查请求状态

等待终端状态为“成功”或“失败”的 HTTP 200。 清单 URL 是成功状态中的“resourceLocation”。

获取操作状态

获取对帐数据请求的状态。

API 请求

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e63ab1d3640

请求参数

请求头文件

请参阅本文中 API 的请求标头列表。

请求正文

不适用。

响应状态

除了 本文中的标准 HTTP 状态 之外，API 还可以返回此 HTTP 状态：

响应有效负载

API 响应有效负载返回以下属性：

对于错误属性：

API 请求

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640

API 响应

响应建议在处理数据之前等待 10 秒。

HTTP/1.1 200 OK  
Retry-After: 10  
{  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime":" 2022-06-1T10-01-05Z",  
"status": "running"  
}

API 请求

（上述请求后的 10 秒）

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640

API 响应

API 返回“成功”状态和“resourceLocation”URI。

HTTP/1.1 200 OK  
Content-Type: application/json  
{  
"createdDateTime": "2022-06-1T10-01-03.4Z",  
"lastActionDateTime": "2022-06-1T10-01-13Z",  
"status": "succeeded",  
"resourceLocation": "https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingmanifests/e03e1882-ff59-4c09-882f-74e60b4d7743"  
}

步骤 3：获取清单有效负载

调用方向清单 URL 发出 GET 请求，详细了解对帐数据存储在 Azure Blob 中的位置。

获取清单

检索清单，该清单包含有关对帐数据的 Azure 存储位置的信息。

API 请求

GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingmanifests/{manifestId}

请求参数

请求头文件

请参阅本文中的 [API 请求标头列表]。

请求正文

不适用。

响应状态

除了 标准 HTTP 状态之外，API 还可以返回此 HTTP 状态：

响应有效负载

API 响应返回以下属性：

示例清单有效负载

{
"version": "1",
"dataFormat": "compressedJSONLines",
"utcCretedDateTime": "2022-04-29T22:40:57.1853571Z",
"eTag": "0x5B168C7B6E589D2",
"partnerTenantId": "14f593ad-1edc-474d-aaa0-83abbf9638da",
"rootFolder": "https://{billing.blob.core.windows.net}/{folder_path}",
"rootFolderSAS": "\*\*\*",
"partitionType": "ItemCount",
"blobCount": 3,
"sizeInBytes": 2000,
"blobs": [
  {
  "name": "{blobName1.json.gz}",
  "sizeinBytes": 500,
  "partitionValue": "1"
  },
  {
  "name": "{blobName2.json.gz}",
  "sizeinBytes": 1000,
  "partitionValue": "2"
  },
  {
  "name": "{blobName3.json.gz}",
  "sizeinBytes": 500,
  "partitionValue": "3"
  }
  ]
}

步骤 4：从存储位置下载使用情况对帐数据

从清单有效负载 API 响应获取“rootFolderSAS”和“rootFolder”属性中的 SAS 令牌和 Blob 存储位置。 使用 Azure 存储 SDK/tool 下载和解压缩 blob 文件。 它采用 JSON 行格式。

标准 API 请求标头

所有 API 都接受以下标头：

标准 API 响应状态

下面是 API 响应中的 HTTP 状态：

使用情况数据属性

带有“full”或“basic”请求参数的计费或未计费使用情况 API 响应返回以下属性：