云数据库 MySQL 开启或关闭CDB日志投递CLS-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： cdb.tencentcloudapi.com 。

开启/关闭CDB慢日志、错误日志投递CLS

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyDBInstanceLogToCLS。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID 示例值：cdb-234rsta
LogType	是	String	日志类型：error/slowlog 示例值：error
Status	是	String	投递状态：ON/OFF 示例值：ON
CreateLogset	否	Boolean	是否需要创建日志集示例值：true
Logset	否	String	需要创建日志集时为日志集名称；选择已有日志集时，为日志集ID 示例值：my_test
CreateLogTopic	否	Boolean	是否需要创建日志主题示例值：true
LogTopic	否	String	需要创建日志主题时为日志主题名称；选择已有日志主题时，为日志主题ID 示例值：my_test
Period	否	Integer	日志主题有效期，不填写时，默认30天示例值：30
CreateIndex	否	Boolean	创建日志主题时，是否创建索引示例值：true
ClsRegion	否	String	CLS所在地域示例值：ap-guangzhou

3. 输出参数

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

4. 示例

示例1 开启或关闭CDB日志投递CLS

CDB实例慢日志、错误日志投递到CLS

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceLogToCLS
<公共请求参数>

{
    "InstanceId": "cdb-ewa3b",
    "LogType": "error",
    "Status": "ON",
    "CreateLogset": true,
    "Logset": "sub_fyrtjbqw",
    "CreateLogTopic": true,
    "LogTopic": "my_test",
    "Period": "1",
    "CreateIndex": true
}

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.UnknownError	未知错误。
InvalidParameter.ControllerNotFoundError	未找到该接口。
InvalidParameter.InvalidParameterError	无效的参数值。
InvalidParameter.JsonUnmarshalError	Json反序列化错误。
MissingParameter.MissingParamError	缺少必要参数。

开启或关闭CDB日志投递CLS

本页目录：