文档

ListCompliancePackTemplates - 查询合规包模板

更新时间:

查询合规包模板列表。

接口说明

本文将提供一个示例,查询合规包模板ct-d254ff4e06a300cf****的详细信息。返回结果显示合规包模板名称BestPracticesForNetwork、合规包模板 ID ct-d254ff4e06a300cf****、合规包模板中的托管规则slb-servercertificate-expired-check等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
CompliancePackTemplateIdstring

合规包模板 ID。

关于如何获取合规包模板 ID,请参见 ListCompliancePackTemplates

ct-d254ff4e06a300cf****
PageSizeinteger

分页时每页显示的数据行数。

取值范围:1~100。起始值:1。默认值:10。

10
PageNumberinteger

页码。

起始值:1。默认值:1。

1
ResourceTypesstring

规则评估的资源类型,输入该参数时 API 响应中只返回评估资源类型等于或者包含输入类型的规则。

ACS::ECS::Instance

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

CompliancePackTemplatesResultobject

合规包模板详情。

PageSizeinteger

分页时每页显示的数据行数。

10
PageNumberinteger

页码。

1
TotalCountlong

合规包模板总数。

1
CompliancePackTemplatesobject []

合规包模板列表。

RiskLevelinteger

合规包中托管规则的风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1
Descriptionstring

合规包描述。

持续检测网络架构、负载额度、网络安全设置的合规性,避免网络安全风险。
ConfigRulesobject []

合规包中托管规则列表。

Descriptionstring

托管规则描述。

SLB证书的到期时间距离当前时间大于参数设定的时间范围,视为“合规”。默认值:90天。
ManagedRuleIdentifierstring

托管规则标识。

slb-servercertificate-expired-check
ManagedRuleNamestring

托管规则名称。

SLB证书到期检查
ConfigRuleParametersobject []

托管规则参数信息。

Requiredboolean

托管规则中参数是否必填。取值:

  • true:参数必填。

  • false:参数非必填。

true
ParameterNamestring

托管规则参数名称。

days
ParameterValuestring

托管规则参数值。

90
RiskLevelinteger

托管规则的风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1
ControlIdstring

法规条例 ID。

说明 仅法规类合规包显示该参数。
3.1
ControlDescriptionstring

法规类条目原文描述,只有法规类合规包包含此信息。

No classic networks exist.
DefaultEnableboolean

规则是否支持快速启用,默认为 false。设置为 true 表示合规包快捷启用时会开启该规则。取值:

  • true:支持。
  • false:不支持。
false
ResourceTypesScopestring

规则评估的资源类型。

ACS::SLB::ServerCertificate
CompliancePackTemplateNamestring

合规包模板名称。

网络合规管理最佳实践
CompliancePackTemplateIdstring

合规包模板 ID。

ct-d254ff4e06a300cf****
Labelsstring

合规包的分类标签。

法规
LastUpdateinteger

合规包最后更新的时间戳。

1663408308
RequestIdstring

请求 ID。

D67FC82F-25AE-4268-A94C-3348340748F9

示例

正常返回示例

JSON格式

{
  "CompliancePackTemplatesResult": {
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 1,
    "CompliancePackTemplates": [
      {
        "RiskLevel": 1,
        "Description": "持续检测网络架构、负载额度、网络安全设置的合规性,避免网络安全风险。",
        "ConfigRules": [
          {
            "Description": "SLB证书的到期时间距离当前时间大于参数设定的时间范围,视为“合规”。默认值:90天。",
            "ManagedRuleIdentifier": "slb-servercertificate-expired-check",
            "ManagedRuleName": "SLB证书到期检查",
            "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"
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:503
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈