CreateScanSbomExport - 生成SBOM下载链接

更新时间:
复制 MD 格式

生成带出具方元数据的 SBOM / 许可证清单下载链接。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-codesec:CreateScanSbomExport

create

*全部资源

*

无 无

请求语法

POST /v1/projects/{projectId}/scans/{scanId}/reports/sbomExports HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

projectId

integer

是

项目 ID。

111

scanId

integer

是

任务 ID。

3088795

请求参数

名称

类型

必填

描述

示例值

format

string

是

取值范围:

  • cyclonedx-json

  • spdx-json

枚举值:

  • cyclonedx-json
  • spdx-json
  • licenses-json
  • licenses-csv

cyclonedx-json

fileName

string

否

下载落盘文件名(含扩展名),会签进 URL 的 Content-Disposition。留空 → 后端按 项目名-sbom-.<扩展名> 生成。含控制字符或路径分隔符(/、\)、或长度 >255 → 400 InvalidFileName。

test-sbom-cyclonedx.cdx.json

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

请求 ID。

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

downloadUrl

string

导出文件下载地址

https://krypton-codesafe.oss-cn-hangzhou.aliyuncs.com/1609837153086803%2F1000108%2F1000893%2F1001080%2Fartifacts%2Fcyclonedx-json%2F1f8dc54097780e9c32941289d2aff5161df694b5bfb2d0aa3fe87fe72a751363.cdx.json?Expires=1789713461&OSSAccessKeyId=STS.NYDdfgGGhFqA4XBNu2EQebMeV&Signature=pnZPAML9CPKOIDyC4b1DK6gQmhs%3D&response-content-disposition=attachment%3B%20filename%3D%22test-sbom-cyclonedx.cdx.json%22%3B%20filename%2A%3DUTF-8%27%27test-sbom-cyclonedx.cdx.json&security-token=CAIS*

format

string

回显制品格式(同上枚举)。

枚举值:

  • cyclonedx-json
  • spdx-json
  • licenses-json
  • licenses-csv

cyclonedx-json

fileName

string

最终生效文件名(客户端指定或后端默认),已签进 Content-Disposition。

test-sbom-cyclonedx.cdx.json

mediaType

string

源制品 MIME 类型(原样透传)。

application/vnd.cyclonedx+json

sizeBytes

integer

源制品字节数(原样透传)。

791355

sha256

string

源制品摘要,供下载完整性校验。

1f8dc54097780e9c32941289d2aff5161df694b5bfb2d0aa3fe87fe72a751363

示例

正常返回示例

JSON格式

{
  "requestId": "9A1F403F-0A85-5578-8B7C-55E3E9408659",
  "downloadUrl": "https://krypton-codesafe.oss-cn-hangzhou.aliyuncs.com/1609837153086803%2F1000108%2F1000893%2F1001080%2Fartifacts%2Fcyclonedx-json%2F1f8dc54097780e9c32941289d2aff5161df694b5bfb2d0aa3fe87fe72a751363.cdx.json?Expires=1789713461&OSSAccessKeyId=STS.NYDdfgGGhFqA4XBNu2EQebMeV&Signature=pnZPAML9CPKOIDyC4b1DK6gQmhs%3D&response-content-disposition=attachment%3B%20filename%3D%22test-sbom-cyclonedx.cdx.json%22%3B%20filename%2A%3DUTF-8%27%27test-sbom-cyclonedx.cdx.json&security-token=CAIS*",
  "format": "cyclonedx-json",
  "fileName": "test-sbom-cyclonedx.cdx.json",
  "mediaType": "application/vnd.cyclonedx+json",
  "sizeBytes": 791355,
  "sha256": "1f8dc54097780e9c32941289d2aff5161df694b5bfb2d0aa3fe87fe72a751363"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.%s Invalid parameter:%s. 无效的参数:%s。
400 NotFound.%s The resource does not exist. 资源不存在。

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

变更历史

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