All Products
Search
Document Center

Cloud Config:ListCompliancePackTemplates

Last Updated:Mar 01, 2024

Queries a list of 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.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CompliancePackTemplateIdstringNo

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

The number of entries per page.

Valid values: 1 to 100. Minimum value: 1. Default value: 10.

10
PageNumberintegerNo

The page number.

Pages start from page 1. Default value: 1

1
ResourceTypesstringNo

The type of the resource evaluated by the rule.

ACS::ECS::Instance

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

Response parameters

ParameterTypeDescriptionExample
object

None.

CompliancePackTemplatesResultobject

The information about the compliance package templates.

PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
TotalCountlong

The total number of the compliance package templates returned.

1
CompliancePackTemplatesobject []

The compliance package templates.

RiskLevelinteger

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

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

The description of the compliance package.

ConfigRulesobject []

The information about managed rules in the compliance package.

Descriptionstring

The description of the managed rule.

ManagedRuleIdentifierstring

The identifier of the managed rule.

slb-servercertificate-expired-check
ManagedRuleNamestring

The name of the managed rule.

ConfigRuleParametersobject []

The input parameters of the managed rule.

Requiredboolean

Indicates whether the input parameter is required. Valid values:

  • true: The parameter is required.
  • false: The input parameter is optional.
true
ParameterNamestring

The name of the input parameter.

days
ParameterValuestring

The value of the input parameter.

90
RiskLevelinteger

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

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

The ID of the regulation.

Note This parameter is available only for regulation compliance packages.
3.1
ControlDescriptionstring

The description of the regulation. This parameter is available only for regulation compliance packages.

No classic networks exist.
DefaultEnableboolean

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
ResourceTypesScopestring

The type of the resource evaluated based on the rule.

ACS::SLB::ServerCertificate
CompliancePackTemplateNamestring

The name of the compliance package template.

CompliancePackTemplateIdstring

The ID of the compliance package template.

ct-d254ff4e06a300cf****
Labelsstring

The tag of the compliance package.

LastUpdateinteger

The time when the compliance package was last updated.

1663408308
RequestIdstring

The request ID.

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": false,
            "ResourceTypesScope": "ACS::SLB::ServerCertificate"
          }
        ],
        "CompliancePackTemplateName": "",
        "CompliancePackTemplateId": "ct-d254ff4e06a300cf****",
        "Labels": "",
        "LastUpdate": 1663408308
      }
    ]
  },
  "RequestId": "D67FC82F-25AE-4268-A94C-3348340748F9"
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
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.

Change history

Change timeSummary of changesOperation
2023-06-04The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 503
Output ParametersThe response structure of the API has changed.