从指定账号组内规则的合规评估结果维度查询合规概要。
接口说明
本文将提供一个示例,查询账号组ca-a4e5626622af0079****
内规则cr-d369626622af008e****
对资源的合规评估结果。返回结果显示,该规则共评估 10 个资源,其中 5 个资源合规。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
config:GetAggregateResourceComplianceByConfigRule | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ComplianceType | string | 否 | 合规评估结果。取值:
| COMPLIANT |
ConfigRuleId | string | 是 | 规则 ID。 关于如何获取规则 ID,请参见 ListAggregateConfigRules 。 | cr-d369626622af008e**** |
AggregatorId | string | 是 | 账号组 ID。 关于如何获取账号组 ID,请参见 ListAggregators 。 | ca-a4e5626622af0079**** |
ResourceAccountId | long | 否 | 账号组内待查询资源所属的阿里云账号 ID。 说明
参数 ResourceAccountId 和 ResourceOwnerId 二选一,推荐使用本参数。
| 100931896542**** |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
JSON
格式
{
"ComplianceResult": {
"TotalCount": 10,
"Compliances": [
{
"ComplianceType": "COMPLIANT",
"Count": 5
}
]
},
"RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB754C"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Invalid.AggregatorId.Value | The specified AggregatorId is invalid. | 账号组ID不存在或无权限使用该账号组。 |
404 | AccountNotExisted | Your account does not exist. | 您的账号不存在。 |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-04-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||||||
|