Modifies the configurations of a compliance package.
Operation Description
This topic provides an example on how to change the value of a parameter for a managed rule whose ID is eip-bandwidth-limit
to 20
. The managed rule is included in the cp-a8a8626622af0082****
compliance package.
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 | Association operation |
---|---|---|---|---|
config:UpdateCompliancePack | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
CompliancePackId | string | Yes | The ID of the compliance package. For more information about how to obtain the ID of a compliance package, see ListCompliancePacks. | cp-a8a8626622af0082**** |
Description | string | No | The description of the compliance package. For more information about how to obtain the description of a compliance package, see ListCompliancePacks. | |
RiskLevel | integer | No | The risk level of the resources that are not compliant with the rules in the compliance package. Valid values:
| 1 |
ConfigRules | array | No | The rules in the compliance package. If you leave this parameter empty, the rules in the compliance package remain unchanged. If you configure this parameter, Cloud Config replaces the existing rules in the compliance package with the specified rules. | |
object | No | |||
ManagedRuleIdentifier | string | No | The ID of the managed rule. Cloud Config automatically create a managed rule of the specified ID and adds the rule to the compliance package. You only need to configure the | eip-bandwidth-limit |
ConfigRuleParameters | array | No | The details of the input parameters of the rule. | |
object | No | |||
ParameterName | string | No | The name of the input parameter. You must configure the | bandwidth |
ParameterValue | string | No | The value of the input parameter. You must configure the | 20 |
ConfigRuleId | string | No | The ID of the rule. If you configure this parameter, Cloud Config adds the rule of the specified ID to the compliance package. You only need to configure the | cr-e918626622af000f**** |
ConfigRuleName | string | No | The name of the rule. | |
Description | string | No | The description of the rule. | |
RiskLevel | integer | No | The risk level of the resources that are not compliant with the rule. Valid values:
| 1 |
ClientToken | string | No | The client token that you want to use to ensure the idempotency of the request. You can use the client to generate the value, but you must ensure 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**** |
CompliancePackName | string | No | The name of the compliance package. For more information about how to obtain the name of a compliance package, see ListCompliancePacks. | |
RegionIdsScope | string | No | The ID of the region whose resources you want to evaluate by using the compliance package. Separate multiple region IDs with commas (,). | cn-hangzhou |
ExcludeResourceIdsScope | string | No | The ID of the resource that you do not want to evaluate by using the compliance package. Separate multiple resource IDs with commas (,). | 23642660635687**** |
ResourceGroupIdsScope | string | No | The ID of the resource group whose resources you want to evaluate by using the compliance package. Separate multiple resource group IDs with commas (,). | rg-aekzdibsjjc**** |
TagKeyScope | string | No | The tag key of the resource that you want to evaluate by using the compliance package. | ECS |
TagValueScope | string | No | The tag value of the resource that you want to evaluate by using the compliance package. NoteYou must configure the TagValueScope parameter together with the TagValueScope parameter. | test |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSON
format
{
"CompliancePackId": "cp-a8a8626622af0082****",
"RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | Invalid.CompliancePackId.Value | The specified CompliancePackId does not exist. | The specified compliance pack ID does not exist. |
400 | CompliancePackExceedMaxCount | The maximum number of compliance pack is exceeded. | The maximum number of compliance pack is exceeded. |
400 | Invalid.ConfigRules.Empty | You must specify ConfigRules. | You must specify ConfigRules. |
400 | Invalid.ConfigRules.Value | The specified ConfigRules is invalid. | The specified ConfigRules is invalid. |
400 | ConfigRuleExceedMaxRuleCount | The maximum number of config rules is exceeded. | The maximum number of config rules is exceeded. |
400 | CompliancePackAlreadyPending | The compliance pack has a pending operation and cannot be updated. | The compliance pack has a pending operation and cannot be updated. |
400 | CompliancePackExists | The compliance pack already exists. | The compliance pack name already exists. |
404 | AccountNotExisted | Your account does not exist. | The specified 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. |
For a list of error codes, visit the Service error codes.