All Products
Search
Document Center

Cloud Config:StartConfigRuleEvaluation

Last Updated:May 17, 2024

Re-evaluates the compliance of resources based on a rule or compliance package.

Operation description

In this example, the cr-9920626622af0035**** rule is used to re-evaluate the compliance of resources.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
config:StartConfigRuleEvaluation
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdstringNo

The rule ID.

For more information about how to obtain the ID of a rule, see ListConfigRules .

cr-9920626622af0035****
RevertEvaluationbooleanNo

Specifies whether to re-evaluate ignored non-compliant resources. Valid values:

  • true: re-evaluates ignored non-compliant resources based on the rule.
  • false: continues to ignore non-compliant resources.
false
CompliancePackIdstringNo

The ID of the compliance package.

For more information about how to obtain the ID of a compliance package, see ListCompliancePacks .

Note You must set either the CompliancePackId or ConfigRuleId parameter.
cp-ac16626622af0053****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

D31EEAD7-BF1E-5927-977A-AFF9342A7273
Resultboolean

Indicates whether the operation is successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "D31EEAD7-BF1E-5927-977A-AFF9342A7273",
  "Result": true
}

Error codes

HTTP status codeError codeError messageDescription
400ConfigRuleNotExistsThe ConfigRule does not exist.The rule does not exist.
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history