更新时间:2025-09-25 GMT+08:00
分享

获取所有访问预览

功能介绍

获取所有访问预览。

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

OK

{
  "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
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档