1. 接口描述
接口请求域名: bsca.tencentcloudapi.com 。
本接口(DescribeKBLicense)用于在知识库中查询许可证信息。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeKBLicense。 |
Version | 是 | String | 公共参数,本接口取值:2021-08-11。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
LicenseExpression | 否 | String | License表达式 示例值:apache-2.0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LicenseList | Array of LicenseUnion | 许可证列表 注意:此字段可能返回 null,表示取不到有效值。 |
NormalizedLicenseExpression | String | 用于匹配的License表达式 示例值:apache-2.0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询 apache-2.0 许可证信息
输入示例
POST / HTTP/1.1
Host: bsca.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKBLicense
<公共请求参数>
{
"LicenseExpression": "apache-2.0"
}
输出示例
{
"Response": {
"LicenseList": [
{
"LicenseDetail": {
"ConditionSet": [
{
"Description": "A copy of the license and copyright notice must be included with the licensed material.",
"Name": "License and copyright notice"
},
{
"Description": "Changes made to the licensed material must be documented.",
"Name": "State changes"
}
],
"Content": " Apache License\n Version 2.0, January 2004\n",
"ForbiddenSet": [
{
"Description": "This license explicitly states that it does NOT grant trademark rights, even though licenses without such a statement probably do not grant any implicit trademark rights.",
"Name": "Trademark use"
},
{
"Description": "This license includes a limitation of liability.",
"Name": "Liability"
},
{
"Description": "This license explicitly states that it does NOT provide any warranty.",
"Name": "Warranty"
}
],
"PermissionSet": [
{
"Description": "The licensed material and derivatives may be used for commercial purposes.",
"Name": "Commercial use"
},
{
"Description": "The licensed material may be modified.",
"Name": "Modification"
},
{
"Description": "The licensed material may be distributed.",
"Name": "Distribution"
},
{
"Description": "This license explicitly states that it does NOT grant any rights in the patents of contributors.",
"Name": "Patent use"
},
{
"Description": "The licensed material may be used and modified in private.",
"Name": "Private use"
}
]
},
"LicenseSummary": {
"Key": "apache-2.0",
"Name": "Apache License 2.0",
"Risk": "MediumRisk",
"SPDXKey": "Apache-2.0",
"ShortName": "Apache 2.0",
"Source": "https://spdx.org/licenses/Apache-2.0.html"
}
}
],
"NormalizedLicenseExpression": "apache-2.0",
"RequestId": "26112148-876a-4bc7-a427-1985371c65fd"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.AccountNotEnough | 账户流量余额不足。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |