检索指定分析器生成的访问分析结果列表 - ListFindings
功能介绍
检索指定分析器生成的访问分析结果列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| AccessAnalyzer:analyzer:listFindings | List | analyzer * | g:ResourceTag/<tag-key> | - | - |
URI
POST /v5/analyzers/{analyzer_id}/findings
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| analyzer_id | 是 | String | 参数解释: 分析器的唯一标识符。 您可以调用 ListAnalyzers API来获取分析器ID。该API的响应参数中会返回一个分析器列表,其中每个分析器对象的 id 字段即为分析器ID。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| filters | 否 | Array of FindingFilter objects | 参数解释: 匹配要返回的访问分析结果的筛选器。 约束限制: 不涉及。 取值范围: 数组长度为1到20。 默认取值: 不涉及。 |
| limit | 否 | Integer | 参数解释: 单页最大结果数。 约束限制: 不涉及。 取值范围: 最小值为1,最大值为200。 默认取值: 100 |
| marker | 否 | String | 参数解释: 页面标记。 约束限制: 不涉及。 取值范围: 最小长度为4,最大长度为400。仅支持包含大小写字母、数字及特殊字符(+、/、=、-、_)。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| criterion | 是 | Criterion object | 参数解释: 要在查找筛选器中使用的条件。 约束限制: 最多只能有一个运算符。 取值范围: 不涉及。 默认取值: 不涉及。 |
| key | 是 | String | 参数解释: 过滤键。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| contains | 否 | Array of strings | 参数解释: 要匹配筛选器的“包含”运算符。 约束限制: 不涉及。 取值范围: 数组长度为1到20。 默认取值: 不涉及。 |
| eq | 否 | Array of strings | 参数解释: 要匹配筛选器的“等于”运算符。 约束限制: 不涉及。 取值范围: 数组长度为1到20。 默认取值: 不涉及。 |
| exists | 否 | Boolean | 参数解释: 要匹配筛选器的“存在”运算符。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| neq | 否 | Array of strings | 参数解释: 要匹配筛选器的“不等于”运算符。 约束限制: 不涉及。 取值范围: 数组长度为1到20。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| findings | Array of FindingSummary objects | 参数解释: 访问分析结果列表。 取值范围: 不涉及。 |
| page_info | PageInfo object | 参数解释: 页面的信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| action | Array of strings | 参数解释: 允许外部主体使用的操作。 取值范围: 不涉及。 |
| analyzed_at | String | 参数解释: 分析资源的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。 取值范围: 不涉及。 |
| condition | Array of FindingCondition objects | 参数解释: 分析的策略语句中导致访问分析结果的条件。 取值范围: 不涉及。 |
| created_at | String | 参数解释: 生成访问分析结果的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。 取值范围: 不涉及。 |
| finding_type | String | 参数解释: 访问分析结果类型。 取值范围: |
| id | String | 参数解释: 访问分析结果的唯一标识符。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。 |
| is_public | Boolean | 参数解释: 表示生成访问分析结果的策略是否允许公共访问资源。 取值范围: 不涉及。 |
| principal | FindingPrincipal object | 参数解释: 访问信任区域内资源的外部主体。 取值范围: 不涉及。 |
| resource | String | 参数解释: 资源的唯一资源标识符。 取值范围: 不涉及。 |
| resource_id | String | 参数解释: 资源的唯一标识符。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)和中划线(-)。 |
| resource_owner_account | String | 参数解释: 拥有资源的账号ID。 取值范围: 最小长度为1,最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
| resource_project_id | String | 参数解释: 资源所属的项目标识符。 取值范围: 最大长度为36。仅支持包含字母、数字、下划线(_)及中划线(-)。 |
| resource_type | String | 参数解释: 资源的类型。 取值范围: |
| sources | Array of strings | 参数解释: 访问分析结果的来源,这指示如何授予生成访问分析结果的访问权限。 取值范围: |
| status | String | 参数解释: 访问分析结果当前状态。 取值范围: |
| updated_at | String | 参数解释: 更新访问分析结果的时间。使用UTC +0时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如:2023-09-07T07:51:10.502Z。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 条件“键”的标识符或名称。 取值范围: 不涉及。 |
| value | String | 参数解释: 条件“键”对应的“值”。 取值范围: 不涉及。 |
请求示例
检索指定分析器生成的结果列表。
POST https://{hostname}/v5/analyzers/{analyzer_id}/findings
{
"filters" : [ {
"criterion" : {
"eq" : [ "iam:agency" ]
},
"key" : "resource_type"
} ],
"limit" : 100,
"marker" : "{marker_string}"
} 响应示例
状态码:200
OK
{
"findings" : [ {
"action" : [ "sts:agencies:assume" ],
"analyzed_at" : "2023-09-07T08:04:41.698Z",
"condition" : [ {
"key" : "g:PrincipalOrgId",
"value" : "org_id"
} ],
"created_at" : "2023-09-07T08:04:41.698Z",
"id" : "{finding_id}",
"is_public" : false,
"principal" : {
"identifier" : "{domain_id}",
"type" : "account"
},
"resource" : "iam::{domain_id}:agency:{agency_name}",
"resource_owner_account" : "{domain_id}",
"resource_id" : "{agency_id}",
"resource_type" : "iam:agency",
"status" : "active",
"updated_at" : "2023-09-07T08:04:41.698Z"
} ],
"page_info" : {
"current_count" : 1,
"next_marker" : null
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。