IsCompleted - 生成报告完成状态查询

生成报告完成状态查询。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
energy:IsCompletednone
*全部资源
*

请求语法

POST /api/v1/carbon/footprint/result/completed HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求参数。

codestring

企业编码。

C-20080808-1
productIdlong

产品 id。

1024
productTypelong

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

1

返回参数

名称类型描述示例值
object
requestIdstring

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

83A5A7DD-8974-5769-952E-590A97BEA34E
dataobject

返回数据。

modifiedTimelong

状态更新时间,毫秒时间戳,例如:1711438780000。

1711438780000
taskKeystring

本次生成任务的唯一键。

550c2b7b-f2e0-4176-ab0a-53ea4b355721
taskShortResultstring

暂未使用,为空。

null
taskStatusstring

生成报告任务状态:可能值为 running、success、error,含义分别为生成中、生成成功、生成失败。如果遇到结果生成失败,请检查模型并修正模型,而后再次生成结果页。

running

示例

正常返回示例

JSON格式

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": {
    "modifiedTime": 1711438780000,
    "taskKey": "550c2b7b-f2e0-4176-ab0a-53ea4b355721",
    "taskShortResult": null,
    "taskStatus": "running"
  }
}

错误码

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