调用StartConfigRuleEvaluation接口使指定规则或合规包(合规包中的规则)执行一次评估。

说明 本接口仅用于触发规则执行一次评估。如果您需要查看规则的本次评估结果,请调用ListConfigRuleEvaluationResults接口。更多信息,请参见ListConfigRuleEvaluationResults

本文将提供一个示例,使规则cr-bdb6626622af0012****执行一次评估。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String StartConfigRuleEvaluation

要执行的操作,取值:StartConfigRuleEvaluation

ConfigRuleId String cr-bdb6626622af0012****

规则ID。

关于如何获取规则ID,请参见ListConfigRules

RevertEvaluation Boolean false

是否恢复已忽略的评估结果。取值:

  • true:恢复已忽略的评估结果。
  • false:不恢复已忽略的评估结果。
CompliancePackId String cp-ac16626622af0053****

合规包ID。

关于如何获取合规包ID,请参见ListCompliancePacks

说明 参数CompliancePackIdConfigRuleId必须二选一。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
RequestId String C32EEAD7-BF64-5927-977A-AFF9342B7275

请求ID。

Result Boolean true

规则执行结果。取值:

  • true:成功。
  • false:失败。

示例

请求示例

http(s)://[Endpoint]/?Action=StartConfigRuleEvaluation
&ConfigRuleId=cr-bdb6626622af0012****
&RevertEvaluation=false
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<StartConfigRuleEvaluationResponse>
    <RequestId>C32EEAD7-BF64-5927-977A-AFF9342B7275</RequestId>
    <Result>true</Result>
</StartConfigRuleEvaluationResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C32EEAD7-BF64-5927-977A-AFF9342B7275",
  "Result" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 ConfigRuleNotExists The ConfigRule does not exist. 此规则不存在。
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. 服务不可用。

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