获取相关预览生成的分析结果 - ListAccessPreviewFindings

功能介绍

获取相关预览生成的分析结果。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
AccessAnalyzer:analyzer:listPreviewFindings	List	analyzer *	g:ResourceTag/<tag-key>	-	-

URI

POST /v5/analyzers/{analyzer_id}/access-previews/{access_preview_id}/findings

表1 路径参数
参数	是否必选	参数类型	描述
analyzer_id	是	String	分析器的唯一标识符。最小长度：1 最大长度：36
access_preview_id	是	String	访问预览的唯一标识符。最小长度：1 最大长度：36

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
filters	否	Array of FindingFilter objects	匹配要返回的分析结果的筛选项。数组长度：1 - 20
limit	否	Integer	单页最大结果数。
marker	否	String	页面标记。

表3 FindingFilter
参数	是否必选	参数类型	描述
criterion	是	Criterion object	要在查找筛选器中使用的条件。最多只能有一个运算符。
key	是	String	过滤键。 resource：资源URN resource_type：资源类型 resource_owner_account：资源所有者账号 is_public：公共访问权限 id：分析结果ID status：分析结果类型 principal_type：主体类型 principal_identifier：主体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：分析结果类型

表4 Criterion
参数	是否必选	参数类型	描述
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	页面的信息。

表6 PreviewFinding
参数	参数类型	描述
action	Array of strings	允许外部主体使用的操作。
change_type	String	结果状态的变化。 unchanged：没有变化 new：新增 changed：有变化
condition	Array of FindingCondition objects	分析的策略语句中导致访问预览分析结果的条件。
created_at	String	生成访问预览分析结果的时间。
existing_finding_id	String	访问分析结果的唯一标识符。
existing_finding_status	String	访问分析结果当前状态。 active：活跃 archived：已解决 resolved：已存档
id	String	访问分析结果的唯一标识符。
is_public	Boolean	表示生成访问分析结果的策略是否允许公共访问资源。
principal	FindingPrincipal object	访问信任区内资源的外部主体。
resource	String	资源的唯一资源标识符。
resource_owner_account	String	拥有资源的账号ID。
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	访问分析结果的来源，这指示如何授予生成访问分析结果的访问权限。
status	String	变化后的状态。 active：活跃 archived：已解决 resolved：已存档

表7 FindingCondition
参数	参数类型	描述
key	String	条件"键"的标识符或名称。
value	String	条件"键"对应的"值"。

表8 FindingPrincipal
参数	参数类型	描述
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：特定身份提供商

表9 PageInfo
参数	参数类型	描述
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
  }
}