GetGwpBenchmarkList - 获取主动减碳排行列表

获取主动减碳排行列表。

接口说明

用户指产品 id,本接口返回获得已经生成结果页中的主动减碳量列表。可用于了解产品各层级的主动减碳量。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

energy:GetGwpBenchmarkList

none

*全部资源

*

请求语法

POST /api/v1/carbon/footprint/result/gwp/benchmark/list HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

请求参数。

code

string

企业编码。

C-20080808-1

productId

integer

产品 id。

1024

productType

integer

产品类型:1 表示请求产品碳足迹,5 表示请求供应链碳足迹。

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求 id,每次请求都是唯一值,便于后续排查问题。

A8AEC6D9-A359-5169-BD1A-BD848BA60D65

data

object

返回数据。

unit

string

排放单位。默认为 kgCO₂e/productUnit,productUnit 为产品选择的单位。随着排放数量 quantity 的大小不同,unit 会自适应转变为 tCO₂e/productUnit 或者 gCO₂e/productUnit,具体转换规则见 quantity 栏的备注。

kgCO₂e/kg

items

array<object>

主动减碳排行列表。

object

减碳项目详情。

name

string

清单名称。

PVC废料回收

carbonEmission

number

清单排放量。保留四位小数。单位为上层 unit。

-0.2061

percent

string

暂未使用。

暂为null

benchmarkName

string

基准线名称。

PVC废料焚烧

benchmarkEmission

number

清单所关联的基准线排放量。保留四位小数。单位为上层 unit。

0.0108

activeReduction

number

主动减排量=基准线排放量-清单排放量。一般地,基准线排放量大于清单排放量。保留四位小数。 单位为上层 unit。

0.2169

示例

正常返回示例

JSON格式

{
  "requestId": "A8AEC6D9-A359-5169-BD1A-BD848BA60D65",
  "data": {
    "unit": "kgCO₂e/kg",
    "items": [
      {
        "name": "PVC废料回收",
        "carbonEmission": -0.2061,
        "percent": "暂为null",
        "benchmarkName": "PVC废料焚烧",
        "benchmarkEmission": 0.0108,
        "activeReduction": 0.2169
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情