GetManagedRule - Cloud Config - Alibaba Cloud Documentation Center

Queries the details of a specified rule template.

Operation description

This topic provides an example of how to query the details of the rule template cdn-domain-https-enabled.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:GetManagedRule

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Identifier	string	Yes	The identifier of the rule template. For more information about how to obtain the rule template identifier, see ListManagedRules.	cdn-domain-https-enabled

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

Response elements

Element	Type	Description	Example
	object	None.
ManagedRule	object	The details of the rule template.
RiskLevel	integer	The risk level of the rule template. Valid values: 1: high risk. 2: medium risk. 3: low risk.	1
Labels	array	The labels of the rule template.
	string	The label of the rule template.	CDN
OptionalInputParameterDetails	object	The information about the optional input parameters for the rule template.	{}
Identifier	string	The identifier of the rule template.	cdn-domain-https-enabled
CompulsoryInputParameterDetails	object	The information about the required input parameters for the rule template.	{}
SourceDetails	array<object>	The trigger methods for the rule.
	object	None.
MessageType	string	The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: The rule is triggered by a configuration change. ScheduledNotification: The rule is triggered periodically.	ConfigurationItemChangeNotification
MaximumExecutionFrequency	string	The execution period of the rule. 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 rule template.	CDN域名开启HTTPS协议加密，视为“合规”。
ConfigRuleName	string	The name of the rule template.	CDN域名开启HTTPS加密
Scope	object	The effective scope of the rule template.
ComplianceResourceTypes	array	The resource types for which the rule template is effective.
	string	The resource type for which the rule template is effective.	ACS::CDN::Domain
HelpUrls	string	The URL of the document that provides guidance on how to fix the issue.	https://example.aliyundoc.com
RequestId	string	The request ID.	7E6DDC09-87C1-5310-A924-3491EAAE6F90

Examples

Success response

JSON format

{
  "ManagedRule": {
    "RiskLevel": 1,
    "Labels": [
      "CDN"
    ],
    "OptionalInputParameterDetails": {},
    "Identifier": "cdn-domain-https-enabled",
    "CompulsoryInputParameterDetails": {},
    "SourceDetails": [
      {
        "MessageType": "ConfigurationItemChangeNotification",
        "MaximumExecutionFrequency": "TwentyFour_Hours"
      }
    ],
    "Description": "CDN域名开启HTTPS协议加密，视为“合规”。",
    "ConfigRuleName": "CDN域名开启HTTPS加密",
    "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.