API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(CodeSec/2026-04-01)的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

项目管理

API

标题

API概述

CreateProject 创建项目 创建项目。
DescribeProjects 获取项目列表信息 分页列出租户下的项目(Project),支持按名称/提示词模糊搜索。

任务管理

API

标题

API概述

CreateCodeBundle 创建代码包并获取上传凭证 创建 pending 状态代码包,并返回预签名 OSS PUT 直传凭证。
CompleteCodeBundle 终结代码包 客户端完成 OSS PUT 后调用,校验上传对象并将代码包置为 ready;若创建时带有触发自动扫描的 CI 元数据,会返回 scanId。
CreateScan 创建扫描任务 基于已 ready 的代码包创建扫描任务。
DescribeScan 查询扫描详情 查询扫描任务详细信息。
DescribeScans 获取任务列表信息 扫描任务的列表查询接口,用于分页获取某个项目下的扫描记录。
DescribeScanResultsByEngine 获取任务结果信息 查询任务结果列表的接口,用于获取某次扫描的 SAST 或 SCA 详细结果。
CreateScanSbomExport 生成SBOM下载链接 生成带出具方元数据的 SBOM / 许可证清单下载链接。