DescribeProjects - 获取项目列表信息

更新时间:
复制 MD 格式

分页列出租户下的项目(Project),支持按名称/提示词模糊搜索。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-codesec:DescribeProjects

list

*全部资源

*

无 无

请求语法

GET /v1/projects HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

maxResults

integer

否

每页数量。默认 10,最大支持 20

20

nextToken

string

否

分页 Token,首页不传 nextToken 省略或为空字符串,翻页原样回传把上一次响应的 nextToken 值不做任何修改地传入下一次请求,响应中 nextToken 为空,已到最后一页

eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0

query

string

否

可按项目名称、提示词模糊查询

project

sortBy

string

否

排序的字段,默认值 lastScanTime 取值如下:

  • lastScanTime 最近一次创建任务时间

  • createdAt 创建项目的时间

  • updatedAt 修改项目的时间

枚举值:

  • updatedAt
  • createdAt
  • lastScanTime

lastScanTime

sortOrder

string

否

指定排序顺序,默认值 desc。 取值如下:

  • desc 倒序

  • asc 正序

枚举值:

  • asc
  • desc

desc

accessType

string

否

接入方式,取值如下:

  • gitlab

  • jenkins

  • yunxiao

  • cli

  • console

  • unknown

非法或空值返回 400 InvalidAccessType;漏洞快照开关关闭时显式传入返回 503 FindingSnapshotDisabled。

枚举值:

  • console :

    console

  • cli :

    cli

  • jenkins :

    jenkins

  • gitlab :

    gitlab

  • yunxiao :

    yunxiao

  • unknown :

    unknown

gitlab

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求唯一标识。

9A1F403F-0A85-5578-8B7C-55E3E9408659

items

array<object>

项目列表。

array<object>

项目信息。

scanCount

integer

项目现存非失败任务数,含排队、运行中、交互式与已取消任务;failed 不计入,invalid 暂计入。无任务为 0。

3

accessType

string

接入方式(gitlab/jenkins/yunxiao/cli/console/unknown);

gitlab

sastRisk

object

SAST 风险计数;项目/租户为当前 new+recurrent 身份,fixed 不计入,ignored 仍计入。无快照时所有计数为 0;当日任务列表使用本任务实际检出项计数,处置桶当前为 0,不能据其推导项目处置分布。

total

integer

SAST 漏洞总数;项目/租户当前风险按身份计数,当日任务列表按实际检出项计数。

57

bySeverity

object

严重度计数映射;固定输出 CRITICAL/HIGH/MEDIUM/LOW/other,缺少风险时各桶为 0(不是 null)。UPPER(TRIM(severity)) 后其他值归 other;各桶之和等于对应风险总数。

CRITICAL

integer

该严重度桶的非负计数;SAST 单位为漏洞,SCA 单位为有已知漏洞的组件。

12

byDisposition

object

人工处置分布;当前风险含 ignored,各字段无数据时为 0。项目/租户以当前身份计数,任务报告按检出项关联的项目身份去重计数。

pending

integer

待确认项目漏洞数。

40

confirmed

integer

已确认需要修复的项目漏洞数。

12

ignored

integer

已忽略的项目漏洞数,仍计入当前风险。

5

scaRisk

object

有已知漏洞的 SCA 组件风险(不是 CVE 条数),每个组件按其最高严重度计入一个桶。项目/租户取最新完整 SCA 每日统计,无完整结果或无快照时计数为 0,不返回 null。

vulnerableComponentCount

integer

有已知漏洞的组件数;优先组件清单 vuln_count>0,无清单时按任务 findings 的 (package_name, version) 去重。

4

bySeverity

object

严重度计数映射;固定输出 CRITICAL/HIGH/MEDIUM/LOW/other,缺少风险时各桶为 0(不是 null)。UPPER(TRIM(severity)) 后其他值归 other;各桶之和等于对应风险总数。

HIGH

integer

该严重度桶的非负计数;SAST 单位为漏洞,SCA 单位为有已知漏洞的组件。

2

riskSnapshotDate

string

最新 SAST 每日统计的配置时区日期(YYYY-MM-DD);null 表示尚未形成每日行。租户/项目列表风险为 0;项目概览若已有底层项目身份则立即展示 SAST 并继续轮询,否则按存量项目显示 0 与重新扫描提示。不是任务完成日期。

2026-11-13

id

integer

项目 ID

934

name

string

项目名称

manual-hDecBn

description

string

描述

111

instructionPrompt

string

用户自然语言提示,描述扫描或结果处理偏好(如忽略低危漏洞等)

1111

engines

object

项目/扫描快照中的引擎开关,(仅 SAST、SCA)

sast

boolean

支持 SAST

true

sastConfig

object

SAST 引擎级配置。

remediation

boolean

组件级修复建议。

sca

boolean

支持 SCA

true

scaConfig

object

SCA 引擎级配置。

remediation

boolean

组件级修复建议。

configRevision

integer

项目配置版本号

1

source

object

项目来源

type

string

项目类型

manual_upload

createdAt

string

创建时间

2026-07-28T03:36:31.573Z

updatedAt

string

更新时间

2026-07-28T03:36:31.573Z

createdBy

string

项目创建者的用户 ID

11111

lastScanTime

string

最近一次创建任务时间。

2026-07-28T03:36:31.573Z

totalCount

integer

总条数

2

maxResults

integer

分页大小。

说明

不传则显示全部项目。

10

nextToken

string

分页 token,空表示最后一页

eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0

示例

正常返回示例

JSON格式

{
  "requestId": "9A1F403F-0A85-5578-8B7C-55E3E9408659",
  "items": [
    {
      "scanCount": 3,
      "accessType": "gitlab",
      "sastRisk": {
        "total": 57,
        "bySeverity": {
          "key": 12
        },
        "byDisposition": {
          "pending": 40,
          "confirmed": 12,
          "ignored": 5
        }
      },
      "scaRisk": {
        "vulnerableComponentCount": 4,
        "bySeverity": {
          "key": 2
        }
      },
      "riskSnapshotDate": "2026-11-13",
      "id": 934,
      "name": "manual-hDecBn",
      "description": "111",
      "instructionPrompt": "1111",
      "engines": {
        "sast": true,
        "sastConfig": {
          "remediation": true
        },
        "sca": true,
        "scaConfig": {
          "remediation": true
        }
      },
      "configRevision": 1,
      "source": {
        "type": "manual_upload"
      },
      "createdAt": "2026-07-28T03:36:31.573Z",
      "updatedAt": "2026-07-28T03:36:31.573Z",
      "createdBy": "11111",
      "lastScanTime": "2026-07-28T03:36:31.573Z"
    }
  ],
  "totalCount": 2,
  "maxResults": 10,
  "nextToken": "eyJ0IjoiMjAyNi0wNy0xNlQwNzo1MzozOC4wMjFaIiwiaSI6MTAwMDQ0OH0"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.%s Invalid parameter:%s. 无效的参数:%s。
400 NotFound.%s The resource does not exist. 资源不存在。
503 ServiceUnavailable.%s Finding snapshot API is disabled (FindingSnapshotDisabled); omit accessType to use the legacy project list.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。