获取所有访问预览 - ListAccessPreviews

功能介绍

获取所有访问预览。

授权信息

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

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

URI

GET /v5/analyzers/{analyzer_id}/access-previews

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

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	单页最大结果数。最小值：1 最大值：200 缺省值：100
marker	否	String	页面标记。最小长度：4 最大长度：400

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
access_previews	Array of AccessPreviewSummary objects	访问预览列表。
page_info	PageInfo object	页面的信息。

表4 AccessPreviewSummary
参数	参数类型	描述
access_preview_id	String	访问预览的唯一标识符。
analyzer_id	String	分析器的唯一标识符。
created_at	String	访问预览创建时间。
status	String	访问预览的状态。 creating：创建中 completed：创建成功 failed：创建失败
status_reason	PreviewStatusReason object	提供有关访问预览当前状态的更多详细信息。

表5 PreviewStatusReason
参数	参数类型	描述
code	String	访问预览当前状态的原因。

表6 PageInfo
参数	参数类型	描述
current_count	Integer	当前页中的项数。
next_marker	String	如果存在更多可用的输出，那么该值表示可用输出比当前响应中包含的更多。在后续调用此操作时，您可以在标记请求参数中使用此值，以获取输出的下一部分。您应该重复这个过程，直到next_marker返回为null。

请求示例

获取所有的访问预览。

GET https://{hostname}/v5/analyzers/{analyzer_id}/access-previews

响应示例

状态码：200

{
  "access_previews" : [ {
    "analyzer_id" : "{analyzer_id}",
    "created_at" : "2023-09-07T08:35:41.997Z",
    "access_preview_id" : "{access_preview_id}",
    "status" : "completed"
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}