# 获取相关预览生成的分析结果 - ListAccessPreviewFindings #### 功能介绍 获取相关预览生成的分析结果。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IAMAccessAnalyzer/doc?api=ListAccessPreviewFindings)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-iam5/iam_02_1126.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | AccessAnalyzer:analyzer:listPreviewFindings | List | analyzer \* | g:ResourceTag/\ | - | - | #### URI POST /v5/analyzers/{analyzer_id}/access-previews/{access_preview_id}/findings 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | analyzer_id | 是 | String | **参数解释**： 分析器的唯一标识符。 您可以调用 [ListAnalyzers](https://console.huaweicloud.com/apiexplorer/#/openapi/IAMAccessAnalyzer/doc?api=ListAnalyzers) API来获取分析器ID。该API的响应参数中会返回一个分析器列表，其中每个分析器对象的 id 字段即为分析器ID。 **取值范围** ： 最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）及中划线（-）。 | | access_preview_id | 是 | String | **参数解释**： 访问预览的唯一标识符。 您可以调用 [ListAccessPreviews](https://console.huaweicloud.com/apiexplorer/#/openapi/IAMAccessAnalyzer/doc?api=ListAccessPreviews) API来检索为指定分析器创建的所有访问预览列表。该API的响应中会包含一个访问预览列表，列表中的每个访问预览摘要对象都包含其唯一的access_preview_id字段，这就是预览访问分析ID。 **取值范围** ： 最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）和中划线（-）。 **约束限制** ： 不涉及。 **默认取值** ： 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | filters | 否 | Array of [FindingFilter] objects | **参数解释**： 匹配要返回的分析结果的筛选项。 **约束限制**： 不涉及。 **取值范围**： 数组长度为1到20。 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释**： 单页最大结果数。 **约束限制**： 不涉及。 **取值范围**： 最小值为1，最大值为200。 **默认取值**： 100 | | marker | 否 | String | **参数解释**： 页面标记，从上一次查询响应中的next_marker字段获取，首次查询不传入。 **约束限制**： 不涉及。 **取值范围**： 最小长度为4，最大长度为400。仅支持包含大小写字母、数字及特殊字符（+、/、=、-、_）。 **默认取值**： 不涉及。 | 表3FindingFilter | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | criterion | 是 | [Criterion] object | **参数解释**： 要在查找筛选器中使用的条件。 **约束限制**： 最多只能有一个运算符。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | key | 是 | String | **参数解释**： 过滤键。 **约束限制**： 不涉及。 **取值范围**： - resource：资源URN - resource_type：资源类型 - resource_owner_account：资源所有者账号 - is_public：公共访问权限 - id：分析结果ID - status：分析结果状态 - principal_type：主体类型 - principal_identifier：主体标识符 - change_type：分析结果状态的变化 - existing_finding_id：已有分析结果ID - existing_finding_status：已有分析结果状态 - condition.g:PrincipalUrn：主体URN - condition.g:PrincipalId：主体ID - condition.g:PrincipalAccount：主体账号 - condition.g:PrincipalOrgId：主体OrgID - condition.g:PrincipalOrgPath：主体组织路径 - condition.g:PrincipalOrgManagementAccountId：主体组织管理账号ID - condition.g:SourceIp：源IP - condition.g:SourceVpc：源VPC - condition.g:SourceVpce：源VPCE - finding_type：分析结果类型 **默认取值**： 不涉及。 | 表4Criterion | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | contains | 否 | Array of strings | **参数解释**： 要匹配筛选器的"包含"运算符。 **约束限制**： 不涉及。 **取值范围**： 数组长度为1到20。 **默认取值**： 不涉及。 | | eq | 否 | Array of strings | **参数解释**： 要匹配筛选器的"等于"运算符。 **约束限制**： 不涉及。 **取值范围**： 数组长度为1到20。 **默认取值**： 不涉及。 | | exists | 否 | Boolean | **参数解释**： 要匹配筛选器的"存在"运算符。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | neq | 否 | Array of strings | **参数解释**： 要匹配筛选器的"不等于"运算符。 **约束限制**： 不涉及。 **取值范围**： 数组长度为1到20。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | findings | Array of [PreviewFinding] objects | **参数解释**： 访问预览生成的分析结果列表。 **取值范围**： 不涉及。 | | page_info | [PageInfo] object | **参数解释**： 分页查询信息，包含当前页的项数和下一页标记。 **取值范围**： 不涉及。 | 表6PreviewFinding | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action | Array of strings | **参数解释**： 允许外部主体使用的操作。 **取值范围**： 不涉及。 | | change_type | String | **参数解释**： 结果状态的变化。 **取值范围**： - unchanged: 没有变化 - new: 新增 - changed: 有变化 | | condition | Array of [FindingCondition] objects | **参数解释**： 分析的策略语句中导致访问分析结果的条件。 **取值范围**： 不涉及。 | | created_at | String | **参数解释**： 生成访问预览分析结果的时间。使用UTC +0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。例如：2023-09-07T07:51:10.502Z。 **取值范围**： 不涉及。 | | existing_finding_id | String | **参数解释**： 访问分析结果的唯一标识符。 **取值范围**： 最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）和中划线（-）。 | | existing_finding_status | String | **参数解释**： 访问分析结果当前状态。 **取值范围**： - active: 活跃 - archived: 已存档 - resolved: 已解决 | | id | String | **参数解释**： 访问分析结果的唯一标识符。 **取值范围**： 最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）和中划线（-）。 | | is_public | Boolean | **参数解释**： 表示生成访问分析结果的策略是否允许公共访问资源。 **取值范围**： 不涉及。 | | principal | [FindingPrincipal] object | **参数解释**： 访问信任区域内资源的外部主体。 **取值范围**： 不涉及。 | | resource | String | **参数解释**： 资源的唯一资源标识符。 **取值范围**： 不涉及。 | | resource_owner_account | String | **参数解释**： 拥有资源的账号ID。 **取值范围**： 最小长度为1，最大长度为36。仅支持包含字母、数字、下划线（_）及中划线（-）。 | | resource_type | String | **参数解释**： 资源的类型。 **取值范围**： - iam:agency：IAM委托 - iam:user：IAM用户 - kms:cmk：DEW密钥 - obs:bucket：OBS桶 - swr:repo：SWR镜像仓库 - cbr:backup：CBR备份 - ims:image：IMS镜像 | | sources | Array of strings | **参数解释**： 访问分析结果的来源。 **取值范围**： - bucket_acl: 桶ACL - bucket_policy: 桶策略 | | status | String | **参数解释**： 变化后的状态。 **取值范围**： - active: 活跃 - archived: 已存档 - resolved: 已解决 | 表7FindingCondition | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**： 条件"键"的标识符或名称。 **取值范围**： 不涉及。 | | value | String | **参数解释**： 条件"键"对应的"值"。 **取值范围**： 不涉及。 | 表8FindingPrincipal | 参数 | 参数类型 | 描述 | |:---|:---|:---| | identifier | String | **参数解释**： 外部主体身份的标识符。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 外部主体身份的类型。 **取值范围**： - all_principal：所有外部主体 - account：账号 - all_user_in_account： 账号下所有用户 - all_agency_in_account： 账号下所有委托 - all_identity_provider_in_account：账号下所有身份提供商 - specific_user：特定用户 - specific_agency：特定委托 - specific_group：特定用户组 - specific_identity_provider：特定身份提供商 | 表9PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current_count | Integer | **参数解释**： 当前页中的项数。 **取值范围**： 不涉及。 | | next_marker | String | **参数解释**： 如果存在更多可用的输出，那么该值表示可用输出比当前响应中包含的更多。在后续调用此操作时，您可以在标记请求参数中使用此值，以获取输出的下一部分。您应该重复这个过程，直到next_marker返回为null。 **取值范围**： 仅支持包含字母、数字、加号（+）、斜线（/）、等号（=）、下划线（_）和中划线（-）。 | #### 请求示例 获取相关预览生成的分析结果。 ``` POST https://{hostname}/v5/analyzers/{analyzer_id}/access-previews/{access_preview_id}/findings { "filters" : [ { "criterion" : { "eq" : [ "iam:agency" ] }, "key" : "resource_type" } ] } ``` #### 响应示例 **状态码：200** ``` { "findings" : [ { "action" : [ "sts::setSourceIdentity", "sts::tagSession", "sts:agencies:assume" ], "change_type" : "new", "condition" : [ { "key" : "g:PrincipalOrgId", "value" : "org_id" } ], "created_at" : "2023-09-07T07:26:23.440Z", "existing_finding_status" : null, "existing_finding_id" : null, "is_public" : false, "id" : "{finding_id}", "principal" : { "identifier" : "{domain_id}", "type" : "account" }, "resource" : "iam::{domain_id}:agency:{agency_name}", "resource_owner_account" : "{domain_id}", "resource_type" : "iam:agency", "status" : "active" } ], "page_info" : { "current_count" : 1, "next_marker" : null } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-iam5/ErrorCode.html)。