All Products
Search

This Product

    Cloud Config:UpdateAggregateConfigRule

    Document Center

    Cloud Config:UpdateAggregateConfigRule

    Last Updated:Dec 12, 2024

    Modifies the description, input parameters, and risk level of a rule in a specific account group.

    Operation description

    This topic provides an example on how to change the risk level of the rule cr-4e3d626622af0080**** in an account group ca-a4e5626622af0079**** to 3, which indicates low risk level.

    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.

    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 keyAssociated operation
    config:UpdateAggregateConfigRuleupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ConfigRuleIdstringYes

    The ID of the rule.

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

    		cr-4e3d626622af0080****
    DescriptionstringNo

    The description of the rule.

    		test_description
    InputParametersobjectNo

    The input parameters of the rule.

    		{"tag1Key":"ECS","tag1Value":"test"}
    MaximumExecutionFrequencystringNo

    The intervals at which the 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
    Note This parameter is required if the ConfigRuleTriggerTypes parameter is set to ScheduledNotification.
    		One_Hour
    ResourceTypesScopearrayNo

    The type of the resource to be evaluated by the rule. Separate multiple resource types with commas (,).

    stringNo

    The type of the resource evaluated by the rule. Separate multiple resource types with commas (,).

    		ACS::ECS::Instance
    RiskLevelintegerNo

    The risk level of the resources that are not compliant with the rule. Valid values:

    • 1: high risk level
    • 2: medium risk level
    • 3: low risk level
    		3
    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.

    		1594295238-f9361358-5843-4294-8d30-b5183fac****
    RegionIdsScopestringNo

    The IDs of the regions to which the rule applies. Separate multiple region IDs with commas (,).

    Note This parameter applies only to a managed rule.
    		cn-hangzhou
    ExcludeRegionIdsScopestringNo

    The IDs of the regions to which the rule not applies. Separate multiple region IDs with commas (,).

    		cn-shanghai
    ExcludeResourceIdsScopestringNo

    The IDs of the resources excluded from the compliance evaluations performed by the rule. Separate multiple resource IDs with commas (,).

    Note This parameter applies only to a managed rule.
    		lb-t4nbowvtbkss7t326****
    ResourceIdsScopestringNo

    The IDs of the resources included from the compliance evaluations performed by the rule. Separate multiple resource IDs with commas (,).

    		lb-5cmbowstbkss9ta03****
    ConfigRuleTriggerTypesstringNo

    The trigger type of the rule. Valid values:

    • ConfigurationItemChangeNotification: The rule is triggered by configuration changes.
    • ScheduledNotification: The rule is periodically triggered.
    Note This parameter applies only to a custom rule.
    		ConfigurationItemChangeNotification
    AggregatorIdstringYes

    The ID of the account group.

    For more information about how to query the ID of an account group, see ListAggregators .

    		ca-a4e5626622af0079****
    ResourceGroupIdsScopestringNo

    The IDs of the resource groups to which the rule applies. Separate multiple resource group IDs with commas (,).

    Note This parameter applies only to a managed rule.
    		rg-aekzc7r7rhx****
    ExcludeResourceGroupIdsScopestringNo

    The IDs of the resource groups to which the rule not applies. Separate multiple resource group IDs with commas (,).

    		rg-bnczc6r7rml****
    TagKeyScopestringNo

    The tag key used to filter resources. The rule applies only to the resources with the specified tag key.

    Note This parameter applies only to a managed rule. You must configure the TagKeyScope and TagValueScope parameters at the same time.
    		ECS
    TagValueScopestringNo

    The tag value used to filter resources. The rule applies only to the resources that use the specified tag value.

    Note This parameter applies only to a managed rule. You must configure the TagKeyScope and TagValueScope parameters at the same time.
    		test
    TagsScopearray<object>No

    The valid tag scope of resources.

    objectNo
    TagKeystringNo

    The tag key.

    		key-1
    TagValuestringNo

    The tag value.

    		value-1
    ExcludeTagsScopearray<object>No

    Exclude the specific tag scope of resources .

    objectNo
    TagKeystringNo

    The tag key.

    		key-2
    TagValuestringNo

    The tag value.

    		value-2
    ConfigRuleNamestringNo

    The name of the rule.

    For more information about how to query the name of a rule, see ListAggregateConfigRules .

    		test_rule
    TagKeyLogicScopestringNo

    The logical relationship among the tag keys if you specify multiple tag keys for the TagKeyScope parameter. For example, if you set the TagKeyScope parameter to ECS,OSS and the TagKeyLogicScope parameter to AND, the rule applies to resources with both the ECS and OSS tag keys. Valid values:

    • AND
    • OR
    		AND
    FolderIdsScopestringNo

    The IDs of the resource directories to which the rule applies, which means that the resources within member accounts in the resource directories are evaluated based on the rule.

    Note

    • This parameter applies only to a rule of a global account group.

    • This parameter applies only to a managed rule.

    		fd-ZtHsRH****
    ExcludeFolderIdsScopestringNo

    The IDs of the resource directories to which the rule does not apply, which means that the resources within member accounts in the resource directories are not evaluated based on the rule. Separate multiple resource directory IDs with commas (,).

    Note

    • This parameter applies only to a rule of a global account group.

    • This parameter applies only to a managed rule.

    		fd-pWmkqZ****
    ExcludeAccountIdsScopestringNo

    The IDs of the member accounts to which the rule does not apply, which means that the resources within the member accounts are not evaluated based on the rule. Separate multiple member account IDs with commas (,).

    Note This parameter applies only to a managed rule.
    		120886317861****
    AccountIdsScopestringNo

    The IDs of the member accounts to which the rule applies, which means that the resources within the member accounts are evaluated based on the rule. Separate multiple member account IDs with commas (,).

    		115748125982****

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    ConfigRuleIdstring

    The ID of the rule.

    		cr-4e3d626622af0080****
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400ExceedMaxRuleCountThe maximum number of rules is exceeded.-
    400ConfigRuleNotExistsThe ConfigRule does not exist.The rule does not exist.
    400ConfigRuleExistsThe ConfigRule already exists.-
    400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
    403AggregatorMemberNoPermissionThe aggregator member is not authorized to perform the operation.The aggregator member is not authorized to perform the operation.
    404AccountNotExistedYour 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.

    Change history

    Change timeSummary of changesOperation
    No change history