ListCompliancePackTemplates - Cloud Config - Alibaba Cloud Documentation Center

Queries compliance package templates.

Operation Description

This topic provides an example on how to query the details of a compliance package template whose ID is ct-d254ff4e06a300cf****. The returned result indicates that the template name is BestPracticesForNetwork, the template ID is ct-d254ff4e06a300cf****, and the ID of the managed rule of the template is slb-servercertificate-expired-check.

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:ListCompliancePackTemplates	List	Config acs:config::{#accountId}:	none	none

Request parameters

Parameter	Type	Required	Description	Example
CompliancePackTemplateId	string	No	The ID of the compliance package template. For more information about how to obtain the ID of a compliance package template, see ListCompliancePackTemplates.	ct-d254ff4e06a300cf****
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Pages start from page 1. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1

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

Response parameters

Parameter	Type	Description	Example
	object
CompliancePackTemplatesResult	object	The information about the compliance package templates returned.
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
TotalCount	long	The total number of the compliance package templates returned.	1
CompliancePackTemplates	array	The compliance package templates.
	object
RiskLevel	integer	The risk level of the resources that are not compliant with the managed rules in the compliance package. Valid values: 1: high risk level 2: medium risk level 3: low risk level	1
Description	string	The description of the compliance package.
ConfigRules	array	The information about managed rules in the compliance package.
	object
Description	string	The description of the managed rule.
ManagedRuleIdentifier	string	The ID of the managed rule.	slb-servercertificate-expired-check
ManagedRuleName	string	The name of the managed rule.
ConfigRuleParameters	array	The input parameters of the managed rule.
	object
Required	boolean	Indicates whether the input parameter is required. Valid values: true: The input parameter is required. false: The input parameter is optional.	true
ParameterName	string	The name of the input parameter.	days
ParameterValue	string	The value of the input parameter.	90
RiskLevel	integer	The risk level of the resources that are not compliant with the managed rule. Valid values: 1: high risk level 2: medium risk level 3: low risk level	1
ControlId	string	The ID of the regulation. NoteThis parameter is available only for regulation compliance packages.	3.1
ControlDescription	string	The description of the regulation. This parameter is available only for regulation compliance packages.	No classic networks exist.
DefaultEnable	boolean	Indicates whether the rule was enabled together with the compliance package. Default value: false. The value true indicates that the rule was enabled together with the compliance package. Valid values: true false	false
CompliancePackTemplateName	string	The name of the compliance package template.
CompliancePackTemplateId	string	The ID of the compliance package template.	ct-d254ff4e06a300cf****
Labels	string	The tag of the compliance package.
LastUpdate	integer	The time when the compliance package was last updated.	1663408308
RequestId	string	The ID of the request.	D67FC82F-25AE-4268-A94C-3348340748F9

Examples

Sample success responses

JSONformat

{
  "CompliancePackTemplatesResult": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 1,
    "CompliancePackTemplates": [
      {
        "RiskLevel": 1,
        "Description": "",
        "ConfigRules": [
          {
            "Description": "",
            "ManagedRuleIdentifier": "slb-servercertificate-expired-check",
            "ManagedRuleName": "",
            "ConfigRuleParameters": [
              {
                "Required": true,
                "ParameterName": "days",
                "ParameterValue": "90"
              }
            ],
            "RiskLevel": 1,
            "ControlId": "3.1",
            "ControlDescription": "No classic networks exist.",
            "DefaultEnable": true
          }
        ],
        "CompliancePackTemplateName": "",
        "CompliancePackTemplateId": "ct-d254ff4e06a300cf****",
        "Labels": "",
        "LastUpdate": 1663408308
      }
    ]
  },
  "RequestId": "D67FC82F-25AE-4268-A94C-3348340748F9"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
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.