tencent cloud

云点播

ModifyKnowledgeBase

下载
聚焦模式
字号
最后更新时间: 2026-09-18 16:50:33

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This API is used to modify a knowledge base. The name and/or description of the knowledge base can be modified. A minimum of one field, Name or Description, is required.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: ModifyKnowledgeBase.
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 after December 25, 2023, this field must be filled in with the app ID when accessing resources in VOD applications, whether in the default application or a newly created application.

KnowledgeBaseId Yes String

ID of the knowledge base to modify.

Name No String

New knowledge base name. Length limit: 1-64 characters.

Description No String

New repository description. Length limit: up to 256 characters.

3. Output Parameters

Parameter Name Type Description
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.

4. Example

Example1 Modifying the Name and Description of a Knowledge Base

Input Example

POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyKnowledgeBase
<Common request parameters>

{
    "SubAppId": 200000,
    "KnowledgeBaseId": "kb-**********",
    "Name": "New name",
    "Description": "This is a new description"
}

Output Example

{
    "Response": {
        "RequestId": "17599a3b-5006-46fa-bc0a-a97b1360bf7b"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈