All Products
Search
Document Center

Cloud Config:GenerateConfigRulesReport

Last Updated:Mar 08, 2023

Generates a compliance evaluation report based on all existing rules.

Operation Description

NoteYou can call this operation to generate the latest compliance evaluation report. To download the report, call the GetConfigRulesReport operation. For more information, see GetConfigRulesReport.

This topic provides an example of how to generate a compliance evaluation report based on all existing rules.

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 keyAssociation operation
config:GenerateConfigRulesReportWrite
  • Config
    acs:config:*:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

AAAAAdDWBF2****
ConfigRuleIdsstringNo

The ID of the rule. Separate multiple rule IDs with commas (,).

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

cr-25d86457e0d900b5****

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6EC7AED1-172F-42AE-9C12-295BC2ADB751
ReportIdstring

The ID of the compliance evaluation report.

crp-88176457e0d900c9****

Examples

Sample success responses

JSONformat

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "ReportId": "crp-88176457e0d900c9****"
}

Error codes

HTTP status codeError codeError messageDescription
400ConfigRuleReportCreatingThe config rule report is being created.The config rule report is being created.
404AccountNotExistedYour account does not exist.The specified account does not exist.
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.