PutEvaluations - 提交自定义函数规则评估结果

更新时间:
复制 MD 格式

函数计算通过PutEvaluations接口将资源评估结果返回给配置审计。

接口说明

前提条件

您必须先调用 CreateConfigRuleCreateAggregateConfigRule 基于函数计算创建自定义规则。

背景信息

关于自定义函数规则的概念、应用场景和运行原理,请参见自定义函数规则定义和运行原理

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

config:PutEvaluations

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Evaluations

string

评估结果。

[{"accountId":120886317861****,"annotation":"The flow log is not enabled.","complianceResourceId":"flowlog-o6wdfo1yvgo4i8****","complianceResourceType":"ACS::CEN::Flowlog","complianceRegionId":"cn-shanghai","complianceType":"NON_COMPLIANT","orderingTimestamp":1588907220408}]

DeleteMode

boolean

是否启用删除模式。取值:

  • true:启用。

  • false(默认值):不启用。

说明

仅当您手动触发或周期触发自定义函数规则评估资源时,该参数有效。如果启用删除模式,会自动删除本次评估期间未更新的评估结果。

false

ResultToken

string

回调令牌。先开通函数计算并创建函数,再通过 CreateConfigRule(SourceOwner=CUSTOM_FC)创建指向该函数的自定义规则;触发规则评估后,从函数 event 入参中提取 resultToken,并在本次函数执行窗口内调用 PutEvaluations 提交评估结果。

说明

ResultToken函数入参中获取。关于如何从函数计算中获取函数入参,请参见查看调用日志

=lAUbfkWp7GL9AFoQEIStinqBMc4FC8sHvip/1F1npkWUDNS2GEm6xwL6Zl/fSr0bbkWY+aiCLjTJxnp4H/yp/8p/Q8VCAtqG5uhRii4sfnYRnTPnE****

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

EDB324E2-A202-5FE4-A9BC-31E2C34F78A4

Result

boolean

自定义函数规则评估结果的提交状态。取值:

  • true:成功。

  • fasle:失败。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "EDB324E2-A202-5FE4-A9BC-31E2C34F78A4",
  "Result": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 NoPermission You are not authorized to perform this operation. 您无权执行此操作。
404 AccountNotExisted Your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服务不可用。

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

变更历史

更多信息,参考变更详情