Update Config Rule Risk Level and Parameters via OpenAPI - Cloud Config - Alibaba Cloud - Cloud Config

Modifies the description, input parameters, risk level, and other settings of a rule.

Operation description

This topic provides an example on how to change the risk level of the rule cr-a260626622af0005**** to 3 (low risk).

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

update

*Rule

acs:config:*:{#accountId}:rule/{#ConfigRuleId}

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleId	string	Yes	The rule ID. For information about how to obtain a rule ID, see ListConfigRules.	cr-a260626622af0005****
Description	string	No	The description of the rule. The description can be up to 500 characters in length.	A maximum of 6 tag groups can be defined. If a resource has all specified tags, it is considered "compliant"
InputParameters	object	No	The input parameters of the rule.	{"tag1Key":"ECS","tag1Value":"test"}
MaximumExecutionFrequency	string	No	The execution frequency of the rule. Valid values: One_Hour: 1 hour. Three_Hours: 3 hours. Six_Hours: 6 hours. Twelve_Hours: 12 hours. TwentyFour_Hours (default): 24 hours. Note If `ConfigRuleTriggerTypes` is set to `ScheduledNotification`, you must specify this parameter. Valid values: Twelve_Hours : 12 hours. Three_Hours : 3 hours. Six_Hours : 6 hours. One_Hour : 1 hour. TwentyFour_Hours : 24 hours.	One_Hour
ResourceTypesScope	array	No	The resource types to which the rule applies. Separate multiple resource types with commas (,).	ACS::ECS::Instance
	string	No	The resource types to which the rule applies. Separate multiple resource types with commas (,).	ACS::ECS::Instance
RiskLevel	integer	No	The risk level of the rule. Valid values: 1: high risk. 2: medium risk. 3: low risk. Valid values: 1 : High risk. 2 : Medium risk. 3 : Low risk.	3
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The `ClientToken` value can contain only ASCII characters and cannot exceed 64 characters in length.	1594295238-f9361358-5843-4294-8d30-b5183fac****
RegionIdsScope	string	No	The rule applies only to resources in the specified region IDs. Separate multiple region IDs with commas (,). Note This parameter applies only to rule templates.	cn-hangzhou
ExcludeRegionIdsScope	string	No	The rule does not apply to resources in the specified regions. Resources in these regions are not evaluated. Separate multiple region IDs with commas (,).	cn-shanghai
ExcludeResourceIdsScope	string	No	The rule does not apply to the specified resource IDs. Resources with these IDs are not evaluated. Separate multiple resource IDs with commas (,). Note This parameter applies only to rule templates.	lb-t4nbowvtbkss7t326****
ResourceIdsScope	string	No	The rule applies only to the specified resource IDs. Separate multiple resource IDs with commas (,).	lb-5cmbowstbkss9ta03****
ConfigRuleTriggerTypes	string	No	The trigger type of the rule. Valid values: ConfigurationItemChangeNotification: configuration change. ScheduledNotification: periodic execution. Note Only custom rules can have this parameter modified.	ConfigurationItemChangeNotification
ResourceGroupIdsScope	string	No	The rule applies only to resources in the specified resource group IDs. Separate multiple resource group IDs with commas (,). Note This parameter applies only to rule templates.	rg-aekzc7r7rhx****
ExcludeResourceGroupIdsScope	string	No	The rule does not apply to resources in the specified resource group IDs. Resources in these resource groups are not evaluated. Separate multiple resource group IDs with commas (,).	rg-bnczc6r7rml****
TagKeyScope `deprecated`	string	No	This parameter is deprecated. Use the `TagsScope` parameter instead. The rule applies only to resources that are bound with the specified tag. Note This parameter applies only to rule templates, and `TagKeyScope` and `TagValueScope` must be set together.	ECS
TagValueScope `deprecated`	string	No	This parameter is deprecated. Use the `TagsScope` parameter instead. The rule applies only to resources that are bound with the specified tag. Note This parameter applies only to rule templates, and `TagKeyScope` and `TagValueScope` must be set together.	test
TagKeyLogicScope	string	No	The logical relationship when the `TagsScope` parameter has multiple values. For example, if `TagsScope` is set to `"TagsScope.1.TagKey":"a","TagsScope.1.TagValue":"a","TagsScope.2.TagKey":"b","TagsScope.2.TagValue":"b"` and this parameter is set to `AND`, the rule applies only to resources that are bound with both the `a:a` and `b:b` tags. If this parameter is not specified, the default logic `OR` is used. This parameter can also be used with the deprecated `TagKeyScope` parameter (not recommended). For example, if `TagKeyScope` is set to `ECS,OSS` and this parameter is set to `AND`, the rule applies only to resources that are bound with both the `ECS` and `OSS` tags. Valid values: AND: logical AND. OR: logical OR. Valid values: OR : OR AND : AND	AND
TagsScope	array<object>	No	The tag scope.
	object	No
TagKey	string	No	The tag key.	key-1
TagValue	string	No	The tag value.	value-1
ExcludeTagsScope	array<object>	No	The excluded tag scope.
	object	No
TagKey	string	No	The tag key.	key-2
TagValue	string	No	The tag value.	value-2
ConfigRuleName	string	No	The rule name. For information about how to obtain a rule name, see ListAggregateConfigRules.	All specified tags exist
Conditions	string	No	The conditions of the custom condition rule in JSON format.	{"ComplianceConditions":"{\"operator\":\"and\",\"children\":[{\"operator\":\"StringEquals\",\"featurePath\":\"$.Status\",\"desired\":\"1\",\"featureSource\":\"CONFIGURATION\"}]}"}
ExtendContent	string	No	Optional. The extended content. This parameter is used together with the 24-hour periodic trigger to specify the trigger time.	{"fixedHour":"12"}
Tag `deprecated`	array<object>	No	[Deprecated] The tags of the resource. This parameter is deprecated. Ignore this parameter because values passed in do not take effect. A maximum of 20 tags can be bound.
	object	No	The tags of the resource. A maximum of 20 tags can be bound.
Key	string	No	The tag key.	key-1
Value	string	No	The tag value.	value-1
ResourceNameScope	string	No	The rule applies only to resources with the specified resource name.	i-xxx

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
ConfigRuleId	string	The rule ID.	cr-a260626622af0005****
RequestId	string	The request ID.	6EC7AED1-172F-42AE-9C12-295BC2ADB751

Examples

Success response

JSON format

{
  "ConfigRuleId": "cr-a260626622af0005****",
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ExceedMaxRuleCount	The maximum number of rules is exceeded.
400	ConfigRuleNotExists	The ConfigRule does not exist.	The rule does not exist.
400	ConfigRuleExists	The ConfigRule already exists.
404	AccountNotExisted	Your account does not exist.
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.