All Products
Search
Document Center

Cloud Config:AttachConfigRuleToCompliancePack

Last Updated:Mar 08, 2023

Adds one or more rules to a compliance package.

Operation Description

The sample request in this topic shows you how to add the cr-6cc4626622af00e7**** rule to the cp-5bb1626622af00bd**** 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.
OperationAccess levelResource typeCondition keyAssociation operation
config:AttachConfigRuleToCompliancePackWrite
  • Config
    acs:config:*:{#accountId}:*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdsstringYes

The ID of the rule to be added to the compliance package. Separate multiple rule IDs with commas (,).

For more information about how to obtain the ID of a rule, see ListConfigRules.

cr-6cc4626622af00e7****
CompliancePackIdstringYes

The ID of the compliance package to which you want to add the rule.

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

cp-5bb1626622af00bd****

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

6EC7AED1-172F-42AE-9C12-295BC2ADB12A
OperateRuleResultobject

The results of the operations to add one or more rules.

OperateRuleItemListarray

The result of the operation to add the rule.

object
ErrorCodestring

The error code.

  • This parameter is empty if the rule is added to the compliance package.
  • An error code is returned if the rule fails to be added to the compliance package. For more information about error codes, visit the API Error Center.
ConfigRuleNotExists
Successboolean

Indicates whether the operation is successful. Valid values:

  • true: The operation is successful.
  • false: The operation fails.
true
ConfigRuleIdstring

The ID of the rule that is added to the compliance package.

cr-6cc4626622af00e7****

Examples

Sample success responses

JSONformat

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB12A",
  "OperateRuleResult": {
    "OperateRuleItemList": [
      {
        "ErrorCode": "ConfigRuleNotExists",
        "Success": true,
        "ConfigRuleId": "cr-6cc4626622af00e7****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400Invalid.ConfigRuleIds.SizeExceedThe maximum number of ConfigRuleIds cannot exceed 20.The maximum number of ConfigRuleIds cannot exceed 20.
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.