调用EvaluatePreConfigRules执行预检规则评估_配置审计(CloudConfig)-阿里云帮助中心

执行预检规则对资源进行合规预检。

接口说明

关于预检规则的概念、运行原理和集成过程，请参见预检规则的定义与运行原理。

预检规则和规则模板是同源规则，当您创建资源后，预检规则可以持续检测资源的合规性。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

config:EvaluatePreConfigRules

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ResourceTypeFormat	string	否	查询开始 Token	ros
ResourceEvaluateItems	array	是	预检规则评估项列表。
	array	否	预检规则评估项。
ResourceLogicalId	string	否	资源逻辑 ID。说明如果该参数为空，则按照`ResourceProperties`的 Base64 位生成。	ResourceLogicId-test
ResourceType	string	否	资源类型。关于如何获取预检规则的标识，请参见 ListPreManagedRules 。说明参数`ResourceType`、`Identifier`和`ResourceProperties`必须同时设置。	ACS::ECS::Instance
Rules	array	否	预检规则列表。
	object	否	预检规则。
Identifier	string	否	规则标识。关于如何获取规则标识，请参见 ListPreManagedRules 。说明参数`ResourceType`、`Identifier`和`ResourceProperties`必须同时设置。	ecs-instance-deletion-protection-enabled
InputParameters	string	否	规则参数。	{}
ResourceProperties	string	否	资源配置项（即将创建的资源属性），例如：资源的规格、所属地域、名称、状态、端口或网口开关状态等。说明参数`ResourceType`、`Identifier`和`ResourceProperties`必须同时设置。	{"ResourceGroupId":"","Memory":8192,"InstanceChargeType":"PostPaid","Cpu":2}
EnableManagedRules	boolean	否	是否启用规则模板。取值： true：启用规则模板。 false（默认值）：不启用规则模板。	false

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

返回参数

名称	类型	描述	示例值
	object	无。
RequestId	string	请求 ID。	129ECF1C-7897-1131-BD0F-4B588AC05400
ResourceEvaluations	array	资源评估结果列表。
	object	资源评估结果。
ResourceLogicalId	string	资源逻辑 ID。说明如果请求参数为空，则自动根据`ResourceProperties`的 Base64 位生成。	ResourceLogicId-test
ResourceType	string	资源类型。	ACS::ECS::Instance
Rules	array	预检规则列表。
	object	预检规则。
Identifier	string	规则标识。	ecs-instance-deletion-protection-enabled
ComplianceType	string	预检规则的合规类型。取值： COMPLIANT：合规。 NON_COMPLIANT：不合规。 NOT_APPLICABLE：不适用。	NON_COMPLIANT
Annotation	string	不合规原因。	{\"configuration\":\"false\",\"desiredValue\":\"True\",\"operator\":\"StringEquals\",\"property\":\"$.DeletionProtection\"}
HelpUrl	string	托管规则修正指导的文档链接。	https://example.aliyundoc.com

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

示例

正常返回示例

JSON格式

{
  "RequestId": "129ECF1C-7897-1131-BD0F-4B588AC05400",
  "ResourceEvaluations": [
    {
      "ResourceLogicalId": "ResourceLogicId-test",
      "ResourceType": "ACS::ECS::Instance",
      "Rules": [
        {
          "Identifier": "ecs-instance-deletion-protection-enabled",
          "ComplianceType": "NON_COMPLIANT",
          "Annotation": "{\\\"configuration\\\":\\\"false\\\",\\\"desiredValue\\\":\\\"True\\\",\\\"operator\\\":\\\"StringEquals\\\",\\\"property\\\":\\\"$.DeletionProtection\\\"}",
          "HelpUrl": "https://example.aliyundoc.com"
        }
      ]
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。