文档

GetResourceComplianceByConfigRule - 查询规则合规评估结果维度的合规概要

更新时间:

从规则的合规评估结果维度查询合规概要。

接口说明

本文将提供一个示例,查询规则cr-d369626622af008e****对资源的评估结果。返回结果显示,资源总数为 10 条,其中合规资源数为5条。

调试

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

授权信息

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

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

请求参数

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

合规评估结果。取值:

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

规则 ID。

关于如何获取规则 ID,请参见 ListConfigRules

cr-d369626622af008e****

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

返回参数

名称类型描述示例值
object
ComplianceResultobject

资源的评估结果。

TotalCountlong

评估资源总数。

10
Compliancesobject []

资源的评估结果。

ComplianceTypestring

合规评估结果。取值:

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

符合评估结果的资源数。例如:ComplianceTypeCOMPLIANT,表示合规的资源数。

5
RequestIdstring

请求 ID。

23306AB1-34E0-468F-BD7B-68D8AEAB753d

示例

正常返回示例

JSON格式

{
  "ComplianceResult": {
    "TotalCount": 10,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 5
      }
    ]
  },
  "RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB753d"
}

错误码

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

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