Domain name for API request: vod.intl.tencentcloudapi.com.
Queries the knowledge base list. Returns all knowledge base info under the designated user.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeKnowledgeBases. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| SubAppId | Yes | Integer | Video-on-demand (VOD) application ID. For customers who activate VOD services from December 25, 2023, this field must be filled in with the app ID when accessing resources in VOD applications, whether default or newly created. |
| Offset | No | Integer | Paging offset. Default value: 0. |
| Limit | No | Integer | Number of returned entries. Default value: 100. Maximum value: 100. |
| Name | No | String | Filter by knowledge base name with exact matching. If not specified, all knowledge bases will be returned. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of eligible knowledge bases. Includes the implicit default knowledge base. |
| KnowledgeBaseSet | Array of KnowledgeBaseInfo | Knowledge base information list. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKnowledgeBases
<Common request parameters>
{
"SubAppId": 200000,
"Offset": 0,
"Limit": 10,
"Name": "New knowledge base"
}{
"Response": {
"KnowledgeBaseSet": [
{
"CreateTime": "2026-06-18T17:08:36+08:00",
"Description": "This is the knowledge base I just created"
"KnowledgeBaseId": "kb-**********",
"Name": "New knowledge base",
"Status": "active"
}
],
"TotalCount": 1,
"RequestId": "e2ae4af8-928f-4d98-9ef4-faaf7d5bdfdc"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.DBError | Operation failed: Database operation failed. |
| InvalidParameterValue | Parameter value error. |
| ResourceNotFound.UserNotExist | The user does not exist. |
文档反馈