All Products
Search

This Product

    Cloud Config:UpdateCompliancePack

    Document Center

    Cloud Config:UpdateCompliancePack

    Last Updated:Jun 21, 2024

    Modifies the configurations of a specific compliance package in the current account.

    Operation description

    This topic provides an example on how to change the value of the eip-bandwidth-limit parameter of a rule in the compliance package cp-a8a8626622af0082**** to 20.

    Debugging

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

    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:UpdateCompliancePackWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    CompliancePackIdstringYes

    The ID of the compliance package.

    For more information about how to obtain the ID of a compliance package, see ListCompliancePacks .

    		cp-a8a8626622af0082****
    DescriptionstringNo

    The description of the compliance package.

    RiskLevelintegerNo

    The risk level of the resources that are not compliant with the rules in the compliance package. Valid values:

    • 1: high
    • 2: medium
    • 3: low
    		1
    ConfigRulesobject []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.

    ManagedRuleIdentifierstringNo

    The identifier of the managed rule. Cloud Config automatically creates a rule based on the identifier of the managed rule and adds the rule to the current compliance package.

    You need to only configure the ManagedRuleIdentifier or ConfigRuleId parameter. If you configure both parameters, the value of the ConfigRuleId parameter takes precedence. For more information about how to obtain the identifier of a managed rule, see ListCompliancePackTemplates .

    		eip-bandwidth-limit
    ConfigRuleParametersobject []No

    The input parameters of the rule.

    ParameterNamestringNo

    The name of the input parameter.

    You must configure the ParameterName and ParameterValue parameters or neither of them. If the managed rule has an input parameter but no default value exists, you must configure this parameter. For more information about how to obtain the name of an input parameter for a managed rule, see ListCompliancePackTemplates .

    		bandwidth
    ParameterValuestringNo

    The value of the input parameter.

    You must configure the ParameterName and ParameterValue parameters or neither of them. If the managed rule has an input parameter but no default value exists, you must configure this parameter. For more information about how to obtain the value of an input parameter for a managed rule, see ListCompliancePackTemplates .

    		20
    ConfigRuleIdstringNo

    The rule ID. If you configure this parameter, Cloud Config adds the rule that has the specified ID to the compliance package.

    You need to only configure the ManagedRuleIdentifier or ConfigRuleId parameter. If you configure both parameters, the value of the ConfigRuleId parameter takes precedence. You can call the ListConfigRules operation to obtain the rule ID.

    		cr-e918626622af000f****
    ConfigRuleNamestringNo

    The rule name.

    DescriptionstringNo

    The description of the event rule.

    RiskLevelintegerNo

    The risk level of the resources that do not comply with the rule. Valid values:

    • 1: high
    • 2: medium
    • 3: low
    		1
    ClientTokenstringNo

    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****
    CompliancePackNamestringNo

    The name of the compliance package.

    For more information about how to obtain the name of a compliance package, see ListCompliancePacks .

    RegionIdsScopestringNo

    The ID of the region whose resources you want to evaluate by using the compliance package. Separate multiple region IDs with commas (,).

    		cn-hangzhou
    ExcludeResourceIdsScopestringNo

    The ID of the resource that you do not want to evaluate by using the compliance package. Separate multiple resource IDs with commas (,).

    		23642660635687****
    ResourceGroupIdsScopestringNo

    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****
    TagKeyScopestringNo

    The tag key of the resource that you want to evaluate by using the compliance package.

    		ECS
    TagValueScopestringNo

    The tag value of the resource that you want to evaluate by using the compliance package.

    Note You must configure the TagValueScope parameter together with the TagValueScope parameter.
    		test

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    CompliancePackIdstring

    The ID of the compliance package.

    		cp-a8a8626622af0082****
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

    {
  "CompliancePackId": "cp-a8a8626622af0082****",
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400Invalid.CompliancePackId.ValueThe specified CompliancePackId does not exist.The specified compliance pack ID does not exist.
    400CompliancePackExceedMaxCountThe maximum number of compliance pack is exceeded.The maximum number of compliance pack is exceeded.
    400Invalid.ConfigRules.EmptyYou must specify ConfigRules.You must specify ConfigRules.
    400Invalid.ConfigRules.ValueThe specified ConfigRules is invalid.The specified ConfigRules is invalid.
    400ConfigRuleExceedMaxRuleCountThe maximum number of config rules is exceeded.The maximum number of config rules is exceeded.
    400CompliancePackAlreadyPendingThe compliance pack has a pending operation and cannot be updated.The compliance pack has a pending operation and cannot be updated.
    400CompliancePackExistsThe compliance pack already exists.The compliance pack name already exists.
    404AccountNotExistedYour account does not exist.The specified 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.