GetManagedRule - Cloud Config - Alibaba Cloud Documentation Center

Queries the details of a managed rule.

Operation description

In this topic, the cdn-domain-https-enabled managed rule is used as an example.

Debugging

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

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:GetManagedRule	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Identifier	string	Yes	The identifier of the managed rule. You can call the ListManagedRules operation to obtain the managed rule identifier.	cdn-domain-https-enabled

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

Response parameters

Parameter	Type	Description	Example
	object
ManagedRule	object	The details of the managed rule.
RiskLevel	integer	The risk level of the resources that are not compliant with the managed rule. Valid values: 1: high risk level 2: medium risk level 3: low risk level	1
Labels	array	The tags of the managed rule.
	string	Classification description of the managed rule.	CDN
OptionalInputParameterDetails	object	The settings of the optional input parameters for the managed rule.	{}
Identifier	string	The identifier of the managed rule.	cdn-domain-https-enabled
CompulsoryInputParameterDetails	object	The settings of the required input parameters for the managed rule.	{}
SourceDetails	object []	The information about the trigger type of the managed rule.
MessageType	string	The trigger type of the managed rule. Valid values: ConfigurationItemChangeNotification: The managed rule is triggered by configuration changes. ScheduledNotification: The managed rule is periodically triggered.	ConfigurationItemChangeNotification
MaximumExecutionFrequency	string	The interval at which the managed rule is triggered. Valid values: One_Hour: 1 hour. Three_Hours: 3 hours. Six_Hours: 6 hours. Twelve_Hours: 12 hours TwentyFour_Hours: 24 hours	TwentyFour_Hours
Description	string	The description of the managed rule.	If HTTPS encryption is enabled for the CDN domain name, the configuration is considered compliant.
ConfigRuleName	string	The name of the managed rule.	cdn-domain-https-enabled
Scope	object	The effective scope of the managed rule.
ComplianceResourceTypes	array	The type of resource to which the managed rule applies.
	string	The type of resource to which the managed rule applies.	ACS::CDN::Domain
HelpUrls	string	The URL of the topic that provides guidance on remediation for the managed rule.	https://example.aliyundoc.com
RequestId	string	The ID of the request.	7E6DDC09-87C1-5310-A924-3491EAAE6F90

Examples

Sample success responses

JSONformat

{
  "ManagedRule": {
    "RiskLevel": 1,
    "Labels": [
      "CDN"
    ],
    "OptionalInputParameterDetails": {},
    "Identifier": "cdn-domain-https-enabled",
    "CompulsoryInputParameterDetails": {},
    "SourceDetails": [
      {
        "MessageType": "ConfigurationItemChangeNotification",
        "MaximumExecutionFrequency": "TwentyFour_Hours"
      }
    ],
    "Description": "If HTTPS encryption is enabled for the CDN domain name, the configuration is considered compliant.",
    "ConfigRuleName": "cdn-domain-https-enabled",
    "Scope": {
      "ComplianceResourceTypes": [
        "ACS::CDN::Domain"
      ]
    },
    "HelpUrls": "https://example.aliyundoc.com"
  },
  "RequestId": "7E6DDC09-87C1-5310-A924-3491EAAE6F90"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ConfigRuleNotExists	The ConfigRule does not exist.	The rule does not exist.
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-07-01

API Description Update. The Error code has changed

see changesets

Change item	Change content
API Description	API Description Update.
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 503