云数据库 MongoDB 开启或关闭日志投递CLS

1. 接口描述

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

开启或关闭MongoDB慢日志、错误日志、操作日志投递CLS

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyDBInstanceLogToCLS。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	指定实例ID。例如：cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-2gdv46zn
LogType	是	String	日志类型。MongoDB-ErrorLog：错误日志，MongoDB-SlowLog：慢日志，MongoDB-OperationLog：操作日志示例值：MongoDB-SlowLog
Status	是	String	投递状态。ON：开启，OFF：关闭。示例值：ON
CreateLogset	否	Boolean	是否需要创建日志集。默认为 false。示例值：false
Logset	否	String	需要创建日志集时为日志集名称；选择已有日志集时，为日志集 ID。默认为空。说明：1. 当参数 Status 的值为 ON 时，Logset 和 LogTopic 参数必须填一个。2. 当参数 CreateLogset 的值为 true 时，Logset 填日志集命名，例如 my_test，否则需要填日志集 id，例如 6adsaw-。示例值：64ae-****-4e59-aba7-f60cd2264ab6
CreateLogTopic	否	Boolean	是否需要创建日志主题。默认为 false。示例值：false
LogTopic	否	String	需要创建日志主题时为日志主题名称；选择已有日志主题时，为日志主题 ID。默认为空。说明：1. 当参数 Status 的值为 ON 时，Logset 和 LogTopic 参数必须填一个。2. 2. 当参数 CreateLogTopic 的值为 true 时，LogTopic 填日志主题命名，例如 my_test，否则需要填日志主题id，例如 6adsaw-。示例值：6a6a21--****-b612-64dad8a3c571
CLSRegion	否	String	CLS 所在地域，不填则默认为 Region 的参数值。示例值：ap-guangzhou

3. 输出参数

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

4. 示例

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

输入示例

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

{
    "InstanceId": "cmgo-2gdv46zn",
    "LogType": "MongoDB-SlowLog",
    "Status": "ON",
    "Logset": "64ae****-****-4e59-aba7-f60cd2264ab6",
    "LogTopic": "6a*6a*21-****-****-b612-64dad8a3c571"
}

输出示例

{
    "Response": {
        "RequestId": "263e942e-099e-4f5d-bcab-0d87ca4eed59"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.DBOperationError	数据库操作失败。
InvalidParameter	参数错误。
InvalidParameterValue.NotFoundInstance	未找到实例。

开启或关闭日志投递CLS

本页目录：