查询知识库组件信息

最近更新时间:2025-03-20 10:51:38

我的收藏

1. 接口描述

接口请求域名: bsca.tencentcloudapi.com 。

本接口(DescribeKBComponent)用于在知识库中查询开源组件信息。本接口根据用户输入的PURL在知识库中寻找对应的开源组件,其中Name为必填字段。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeKBComponent。
Version String 公共参数,本接口取值:2021-08-11。
Region String 公共参数,本接口不需要传递此参数。
PURL PURL 组件的PURL

3. 输出参数

参数名称 类型 描述
Component Component 匹配的组件信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询openssl组件信息

输入示例

复制
复制成功
POST / HTTP/1.1
Host: bsca.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKBComponent
<公共请求参数>

{
    "PURL": {
        "Name": "openssl"
    }
}

输出示例

复制
复制成功
{
    "Response": {
        "Component": {
            "CodeLocationList": [
                "https://github.com/openssl/openssl.git",
                "https://android.googlesource.com/platform/external/openssl"
            ],
            "Homepage": "https://www.openssl.org",
            "LastUpdateTime": "2023-09-11 22:08:48.000000",
            "LicenseExpression": "openssl-ssleay",
            "NicknameList": null,
            "PURL": {
                "Name": "openssl",
                "Namespace": "",
                "Protocol": "generic",
                "Qualifiers": [],
                "Subpath": "",
                "Version": "1.0.0"
            },
            "Summary": "OpenSSL is a robust, commercial-grade, full-featured Open Source Toolkit for the Transport Layer Security (TLS) protocol formerly known as the Secure Sockets Layer (SSL) protocol. The protocol implementation is based on a full-strength general purpose cryptographic library, which can also be used stand-alone.",
            "TagList": [
                "network"
            ],
            "VersionInfo": {
                "CopyrightList": [
                    "Copyright (c) 1998-2008 The OpenSSL Project",
                    "Copyright (c) 1995-1998 Eric Young (eay@cryptsoft.com)",
                    "holder is Tim Hudson (tjh@cryptsoft.com)"
                ],
                "PublishTime": "2015-01-22 09:46:52.000000",
                "TagList": [
                    "copyright_updated"
                ]
            }
        },
        "RequestId": "deadc0de-3ab7-45dd-9def-6b3e087dd354"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.AccountNotEnough 账户流量余额不足。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

返回顶部
可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。