Skip to main content
GET
列出代码扫描

权限

需要服务用户个人访问令牌,并且在企业级别拥有 ViewAccountCodeScans 权限。

行为

返回企业内的代码扫描,按最新时间排序。可使用此接口轮询通过 启动代码扫描 发起的扫描的 statuswaitingpendingrunningcompleted (或 failed / cancelled) 。awaiting_user_input 仅适用于从 Web 应用发起的交互式扫描;通过 API 发起的扫描不会进入此状态。

过滤器

  • time_after / time_before:以秒为单位的 Unix 时间戳 (UTC) ,用于限定扫描的创建时间。
  • repo_name:仅返回扫描过此代码仓库的扫描记录,包括包含该代码仓库的多代码仓库扫描。
  • org_ids:仅返回这些组织中的扫描记录。
结果使用不透明游标 (after / first) 进行分页。若仅查询单个组织,请使用列出代码扫描 (组织)

授权

Authorization
string
header
必填

服务用户凭据(前缀:cog_)

查询参数

time_before
integer | null
time_after
integer | null
after
string | null
first
integer
默认值:100
必填范围: 1 <= x <= 200
repo_name
string | null

筛选扫描过此代码仓库的扫描任务。即使该代码仓库不是扫描的主代码仓库,也会匹配多代码仓库扫描,因此返回项中的 repo_name 可能不同。

org_ids
string[] | null

筛选这些组织中的扫描任务。

响应

成功响应

items
CodeScanResponse · object[]
必填
end_cursor
string | null

用于获取下一页的游标;如果这是最后一页,则为 None。

has_next_page
boolean
默认值:false

此页之后是否还有更多项。

total
integer | null

可选的总数(为提升性能可省略)。