ListManagedRules - Cloud Config - Alibaba Cloud Documentation Center

Queries a list of managed rules supported by Cloud Config.

Operation description

Background information

For more information about how to define, execute, and integrate a managed rule, see Definition and execution of rules.

Description

This topic provides an example on how to query all managed rules whose keyword is CDN. The response shows that 21 managed rules exist.

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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
config:ListManagedRules	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword of the managed rule.	CDN
PageSize	integer	No	The number of entries per page. Valid values: 1 to 100. Minimum value: 1. Default value: 10.	10
PageNumber	integer	No	The page number of the page to return. Pages start from page 1. Default value: 1	1
RiskLevel	integer	No	The risk level of the managed rule. Valid values: 1: high 2: medium 3: low	1
ResourceTypes	string	No	The type of the resources to be evaluated based on the rule.	ACS::ECS::Instance

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

Response parameters

Parameter	Type	Description	Example
	object	This operation does not return any operation-specific parameters.
RequestId	string	The ID of the request.	B3E605AB-63D5-1EE0-BFA6-0BAC247B0461
ManagedRules	object	The managed rules.
PageSize	integer	The number of entries returned per page. Valid values: 1 to 500.	1
PageNumber	integer	The page number. Page start from page 1.	10
TotalCount	long	The total number of entries returned.	1
ManagedRuleList	array<object>	The details of the managed rule.
ManagedRule	object	The type of the resource to be evaluated against the managed rule.
RiskLevel	integer	The risk level of the resources that do not comply with the rule. Valid values: 1: high 2: medium 3: low	1
Description	string	The description of the managed rule.	The description of the test rule.
Labels	array	The classification description of the managed rule.
Labels	string	The classification information of the managed rule.	CDN
Identifier	string	The unique identifier of the managed rule.	cdn-domain-https-enabled
ConfigRuleName	string	The name of the managed rule.	test-rule-name
HelpUrls	string	The URL of the topic that describes how the managed rule remediates the incompliant configurations.	https://example.aliyundoc.com
Scope	object	The effective scope of the managed rule.
ComplianceResourceTypes	array	The types of resources to which the managed rule applies.
ComplianceResourceTypes	string	The type of the resource to which the managed rule applies.	ACS::CDN::Domain
SupportPreviewManagedRule	boolean	Indicates whether precheck is supported. Valid values: true false	true
RemediationTemplateIdentifier	string	The ID of the remediation template.	ACS-CDN-SetDomainServerCertificate
RemediationTemplateName	string	The name of the remediation template.	Configure encryption rules for OSS buckets

Examples

Sample success responses

JSONformat

{
  "RequestId": "B3E605AB-63D5-1EE0-BFA6-0BAC247B0461",
  "ManagedRules": {
    "PageSize": 1,
    "PageNumber": 10,
    "TotalCount": 1,
    "ManagedRuleList": [
      {
        "RiskLevel": 1,
        "Description": "The description of the test rule.",
        "Labels": [
          "CDN"
        ],
        "Identifier": "cdn-domain-https-enabled",
        "ConfigRuleName": "test-rule-name",
        "HelpUrls": "https://example.aliyundoc.com",
        "Scope": {
          "ComplianceResourceTypes": [
            "ACS::CDN::Domain"
          ]
        },
        "SupportPreviewManagedRule": true,
        "RemediationTemplateIdentifier": "ACS-CDN-SetDomainServerCertificate",
        "RemediationTemplateName": "Configure encryption rules for OSS buckets"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
503	ServiceUnavailable	The 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 time	Summary of changes	Operation
2023-04-13	The Error code has changed. The response structure of the API has changed	View Change Details
2023-03-08	The Error code has changed	View Change Details