{ "name": "bsca", "display_name": "软件成分分析", "description": "介绍如何使用API对软件成分分析进行操作，包括新建分析、查看分析列表、查看报告等。", "domain": "other", "api_version": "2021-08-11", "endpoint": "bsca.tencentcloudapi.com", "actions": [ { "name": "DescribeKBComponent", "description": "本接口(DescribeKBComponent)用于在知识库中查询开源组件信息。本接口根据用户输入的PURL在知识库中寻找对应的开源组件，其中Name为必填字段。", "status": "online", "parameters": [ { "name": "PURL", "type": "object", "required": true, "description": "组件的PURL", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "组件名称", "example": "curl" }, { "name": "Protocol", "type": "string", "required": false, "description": "组件所属的类型，如：github, gitlab, generic, deb, rpm, maven 等", "example": "deb" }, { "name": "Namespace", "type": "string", "required": false, "description": "组件名的前缀名，如github和gitlab的用户名，deb的操作系统，maven包的group id等", "example": "debian" }, { "name": "Qualifiers", "type": "array", "required": false, "description": "修饰组件的额外属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "额外属性的名称。", "example": "distro_version" }, { "name": "Value", "type": "string", "required": true, "description": "额外属性的值。", "example": "14.04" } ] }, { "name": "Subpath", "type": "string", "required": false, "description": "相对于组件包根位置的子目录", "example": "/release" }, { "name": "Version", "type": "string", "required": false, "description": "组件版本号", "example": "7.50.3" } ] } ], "required": [ "PURL" ] }, { "name": "DescribeKBComponentVersionList", "description": "查询特定组件的版本列表", "status": "online", "parameters": [ { "name": "PURL", "type": "object", "required": true, "description": "要查询的组件 PURL", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "组件名称", "example": "curl" }, { "name": "Protocol", "type": "string", "required": false, "description": "组件所属的类型，如：github, gitlab, generic, deb, rpm, maven 等", "example": "deb" }, { "name": "Namespace", "type": "string", "required": false, "description": "组件名的前缀名，如github和gitlab的用户名，deb的操作系统，maven包的group id等", "example": "debian" }, { "name": "Qualifiers", "type": "array", "required": false, "description": "修饰组件的额外属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "额外属性的名称。", "example": "distro_version" }, { "name": "Value", "type": "string", "required": true, "description": "额外属性的值。", "example": "14.04" } ] }, { "name": "Subpath", "type": "string", "required": false, "description": "相对于组件包根位置的子目录", "example": "/release" }, { "name": "Version", "type": "string", "required": false, "description": "组件版本号", "example": "7.50.3" } ] }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页号", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "页大小", "example": "10" }, { "name": "Order", "type": "string", "required": false, "description": "排序方式，可以是\"ASC\"或\"DESC\"，默认\"DESC\"", "example": "ASC" }, { "name": "OrderBy", "type": "array", "required": false, "description": "排序字段，可能的字段包括“Version”、\"PublishTime\"", "example": "[\"PublishTime\",\"Version\"]", "item_type": "string" }, { "name": "Filter", "type": "object", "required": false, "description": "Tag筛选", "example": "无", "children": [ { "name": "IncludeTags", "type": "array", "required": false, "description": "包括的Tag", "example": "[\"CopyrightUpdated\"]", "item_type": "string" }, { "name": "ExcludeTags", "type": "array", "required": false, "description": "排除的Tag", "example": "[\"LicenseUpdated\"]", "item_type": "string" } ] } ], "required": [ "PURL" ] }, { "name": "DescribeKBComponentVulnerability", "description": "本接口(DescribeKBComponentVulnerability)用于在知识库中查询开源组件的漏洞信息。", "status": "online", "parameters": [ { "name": "PURL", "type": "object", "required": true, "description": "组件的PURL，其中Name和Version为必填字段", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "组件名称", "example": "curl" }, { "name": "Protocol", "type": "string", "required": false, "description": "组件所属的类型，如：github, gitlab, generic, deb, rpm, maven 等", "example": "deb" }, { "name": "Namespace", "type": "string", "required": false, "description": "组件名的前缀名，如github和gitlab的用户名，deb的操作系统，maven包的group id等", "example": "debian" }, { "name": "Qualifiers", "type": "array", "required": false, "description": "修饰组件的额外属性 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "额外属性的名称。", "example": "distro_version" }, { "name": "Value", "type": "string", "required": true, "description": "额外属性的值。", "example": "14.04" } ] }, { "name": "Subpath", "type": "string", "required": false, "description": "相对于组件包根位置的子目录", "example": "/release" }, { "name": "Version", "type": "string", "required": false, "description": "组件版本号", "example": "7.50.3" } ] }, { "name": "Language", "type": "string", "required": false, "description": "语言，ZH或EN", "example": "ZH" } ], "required": [ "PURL" ] }, { "name": "DescribeKBLicense", "description": "本接口(DescribeKBLicense)用于在知识库中查询许可证信息。", "status": "online", "parameters": [ { "name": "LicenseExpression", "type": "string", "required": false, "description": "License表达式", "example": "apache-2.0" } ], "required": [] }, { "name": "DescribeKBVulnerability", "description": "本接口(DescribeKBVulnerability)用于在知识库中查询漏洞详细信息，支持根据CVE、Vul ID、CNVD ID、CNNVD ID查询。", "status": "online", "parameters": [ { "name": "CVEID", "type": "array", "required": false, "description": "根据CVE ID查询（不能与其他参数同时存在）", "example": "[\"CVE-2020-1971\", \"CVE-2019-1551\"]", "item_type": "string" }, { "name": "VulID", "type": "array", "required": false, "description": "根据Vul ID查询（不能与其他参数同时存在）", "example": "[\"pcmgr-303514\"]", "item_type": "string" }, { "name": "CNVDID", "type": "array", "required": false, "description": "根据CNVD ID查询（不能与其他参数同时存在）", "example": "[\"CNVD-2021-04811\"]", "item_type": "string" }, { "name": "CNNVDID", "type": "array", "required": false, "description": "根据CNNVD ID查询（不能与其他参数同时存在）", "example": "[\"CNNVD-202108-1945\"]", "item_type": "string" }, { "name": "Language", "type": "string", "required": false, "description": "语言，ZH或EN", "example": "ZH" } ], "required": [] }, { "name": "MatchKBPURLList", "description": "本接口(MatchKBPURLList)用于在知识库中匹配与特征对应的开源组件列表。", "status": "online", "parameters": [ { "name": "SHA1", "type": "string", "required": false, "description": "SHA1。", "example": "7ed845de1dfe070d43511fab321784e6c4118398" } ], "required": [] }, { "name": "SearchKBComponent", "description": "根据输入的组件名、组件类型搜索相应的组件，返回符合条件的组件列表", "status": "online", "parameters": [ { "name": "Query", "type": "string", "required": true, "description": "需要搜索的组件名", "example": "openssl" }, { "name": "Protocol", "type": "string", "required": false, "description": "需要搜索的组件类型", "example": "generic" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "分页参数，从 0 开始", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页参数，设置每页返回的结果数量", "example": "20" } ], "required": [ "Query" ] } ] }