使用 API 导出和读取您的碳足迹

碳足迹没有专用的公共 API。 不过，您可以通过 BigQuery Data Transfer Service API 导出您的碳足迹 然后使用 BigQuery API 查询数据。

使用 BigQuery Data Transfer Service API

如需调用 BigQuery Data Transfer Service API，您可以使用 客户端库或调用 REST API。

以下文档介绍了如何使用 REST API 创建碳足迹转移配置和回填。但是，对于 为方便起见，您可能希望使用客户端 ID 进行等效的 API 调用， 。

通过 REST API 创建导出

使用以下载荷调用 BigQuery Data Transfer Service API 的 transferConfigs.create 端点以创建转移作业：

{
  "dataSourceId": "61cede5a-0000-2440-ad42-883d24f8f7b8",
  "displayName": "NAME",
  "params": {
    "billing_accounts": "BILLING_ACCOUNT_IDS"
  },
  "destinationDatasetId": "DATASET"
}

您需要将其中的：

  • 将 NAME 替换为您的传输配置名称。例如：“公司碳排放量 报告”
  • 将 BILLING_ACCOUNT_IDS 替换为您的结算账号 ID。该值可以是 以英文逗号分隔的结算账号 ID 列表。例如：XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET 替换为当前项目中的目标 BigQuery 数据集 ID。例如 company_carbon_report

创建转移配置后，系统将在未来的每个月 15 日自动导出碳排放数据。如需导出历史数据，请参阅 。

通过 REST API 运行历史数据回填

如需导出现有转移配置（见上文）的历史碳排放数据，您必须请求对转移配置进行回填。

如需创建回填，请向POST transferConfigs.startManualRuns 端点，使用上一步中创建的传输的标识符 （例如 projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000） 以及以下载荷：

{
  "requestedTimeRange": {
    "startTime": "<var>START_TIME</var>",
    "endTime": "<var>END_TIME</var>"
  }
}

其中：

  • START_TIME 是一个时间戳，用于指定要回填的范围的开始时间。例如：2021-02-15T00:00:00Z。 请注意，您可以在此处指定的最早日期为 2021 年 2 月 15 日。 因为它包含 2021 年 1 月的数据。
  • END_TIME 是一个时间戳，用于指定要回填的范围的结束时间。例如：2022-09-15T00:00:00Z。 您可以使用当前日期。

通过 API 查询现有导出

在查询 API 之前，请编写一个 SQL 查询，以从导出的数据集中返回所需的数据。您可以在 BigQuery 控制台。

配置“导出到 BigQuery”功能后， 使用 BigQuery API 或 BigQuery 库来运行 查询。

后续步骤