首页 配置审计 开发参考 API参考 API参考(2020-09-07) API目录 合规包 单账号 GetConfigRuleComplianceByPack - 查询合规包中规则维度合规统计

GetConfigRuleComplianceByPack - 查询合规包中规则维度合规统计

更新时间: 2024-06-17 15:29:22

查询指定合规包中规则维度合规统计。

接口说明

本文将提供一个示例,查询合规包cp-541e626622af0087****中规则的合规结果。返回结果显示规则总数为 1 个,不合规规则数为 0 个。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:GetConfigRuleComplianceByPackRead
  • 全部资源
    *

请求参数

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

合规包 ID。

关于如何获取合规包 ID,请参见 ListCompliancePacks

cp-541e626622af0087****

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

返回参数

名称类型描述示例值
object

RequestIdstring

请求 ID。

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

合规包中规则的合规结果。

CompliancePackIdstring

合规包 ID。

cp-541e626622af0087****
NonCompliantCountinteger

不合规规则数。

0
ConfigRuleCompliancesobject []

合规包中的规则及合规结果列表。

ComplianceTypestring

规则合规评估结果。取值:

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:无数据。
COMPLIANT
ConfigRuleNamestring

合规包中的规则名称。

弹性IP实例带宽满足最低要求
ConfigRuleIdstring

合规包中的规则 ID。

cr-fdc8626622af00f9****
TotalCountinteger

合规包中的规则总数。

1

示例

正常返回示例

JSON格式

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "ConfigRuleComplianceResult": {
    "CompliancePackId": "cp-541e626622af0087****",
    "NonCompliantCount": 0,
    "ConfigRuleCompliances": [
      {
        "ComplianceType": "COMPLIANT",
        "ConfigRuleName": "弹性IP实例带宽满足最低要求",
        "ConfigRuleId": "cr-fdc8626622af00f9****"
      }
    ],
    "TotalCount": 1
  }
}

错误码

HTTP status code错误码错误信息描述
400Invalid.CompliancePackId.ValueThe specified CompliancePackId does not exist.合规包ID不存在。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

上一篇: GetCompliancePackReport - 获取合规包评估报告 下一篇: GetResourceComplianceByPack - 查询合规包资源合规结果