DescribeCompliance - 查询合规结果统计

查询资源的合规结果统计。

调试

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

授权信息

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

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

请求参数

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

资源类型。

当您按资源维度查询资源评估结果时,必须配置参数 ResourceType 和 ResourceId。

ACS::ECS::Instance
ResourceIdstring

资源 ID。

当您按资源维度查询资源评估结果时,必须配置参数 ResourceType 和 ResourceId。

i-bp151g9tpto890zr****
ComplianceTypestring

合规类型。取值:

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

规则 ID。

当您按规则维度查询资源评估结果时,必须同时配置参数 ConfigRuleId、ResourceType 和 ResourceId,否则 ConfigRuleId 无效。

cr-12b398b633820012****
MultiAccountboolean

该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组

false
MemberIdlong

该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组

100931896542****

返回参数

名称类型描述示例值
object

合规统计结果。

ComplianceResultobject

合规结果统计。

Compliancesarray<object>

资源合规结果统计。

Compliancesobject

无。

ComplianceTypestring

合规类型。取值:

  • COMPLIANT:合规。

  • NON_COMPLIANT:不合规。

  • NOT_APPLICABLE:不适用。

  • INSUFFICIENT_DATA:无数据。

COMPLIANT
Countinteger

指定合规类型的数量统计。

  • 当入参指定 ResourceId 时,该参数为资源数统计值。

  • 当入参指定 ConfigRuleId 时,该参数为规则数统计值。

12
TotalCountlong

所有合规类型的数量统计。

  • 当入参指定 ResourceId 时,该参数为资源数量统计值。

  • 当入参指定 ConfigRuleId 时,该参数为规则数量统计值。

12
RequestIdstring

请求 ID。

17306AB1-34E0-468F-BD7B-68D8AEAB754F

示例

正常返回示例

JSON格式

{
  "ComplianceResult": {
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 12
      }
    ],
    "TotalCount": 12
  },
  "RequestId": "17306AB1-34E0-468F-BD7B-68D8AEAB754F"
}

错误码

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

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