EvaluatePreConfigRules

0.0.201

Executes evaluation rules to evaluate resources.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation

Operation	Access level	Resource type	Condition key	Associated operation
config:EvaluatePreConfigRules	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example

Parameter	Type	Required	Description	Example
ResourceEvaluateItems	array<object>	Yes	The resources that you want to evaluate.
	object	Yes
ResourceLogicalId	string	No	The logical ID of the resource.	ResourceLogicId-test
ResourceType	string	No	The type of the resource.	ACS::ECS::Instance
Rules	array<object>	No	The evaluation rules.
	object	No
Identifier	string	No	The identifier of the evaluation rule. For more information about how to obtain the identifier of an evaluation rule, see ListManagedRules .	ecs-instance-deletion-protection-enabled
InputParameters	string	No	The input parameters of the evaluation rule.	{}
ResourceProperties	string	No	The properties of the resource.	{ "ImageId": "ubuntu_18_04_64_20G_alibase_20190624.vhd", "SecurityGroupId": "sg-bp15ed6xe1yxeycg****", "HostName": "LocalHostName", "RegionId": "cn-hangzhou" }
EnableManagedRules	boolean	No	Specifies whether to enable the managed rule. Valid values: true: enables the managed rule. false: does not enable the managed rule. This is the default value. Note After you create an evaluation rule, a managed rule that has the same settings as the evaluation rule is created. After you create a resource, the managed rule can be used to continuously check the compliance of the resource.	false

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	129ECF1C-7897-1131-BD0F-4B588AC05400
ResourceEvaluations	array<object>	The details of the compliance evaluation result.
ResourceEvaluation	object
ResourceLogicalId	string	The logical ID of the resource. Note If the ResourceLogicalId request parameter is left empty, the value of the ResourceLogicalId response parameter is generated based on the value of the `ResourceProperties` parameter.	ResourceLogicId-test
ResourceType	string	The type of the resource.	ACS::ECS::Instance
Rules	array<object>	The evaluation rules.
Rule	object
Identifier	string	The identifier of the evaluation rule.	ecs-instance-deletion-protection-enabled
ComplianceType	string	The compliance type of the resource that was evaluated by using the evaluation rule. Valid values: COMPLIANT: The resource was evaluated as compliant. NON_COMPLIANT: The resource was evaluated as incompliant. NOT_APPLICABLE: The evaluation rule does not apply to the resource.	NON_COMPLIANT
Annotation	string	The reason why the resource was evaluated as incompliant.	{\"configuration\":\"false\",\"desiredValue\":\"True\",\"operator\":\"StringEquals\",\"property\":\"$.DeletionProtection\"}
HelpUrl	string	The URL of the topic that describes how the managed rule remediates the incompliant configurations.	https://example.aliyundoc.com

Examples

Sample success responses

JSONformat

            
            
          
{
  "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"
        }
      ]
    }
  ]
}