云数据库 MongoDB 查询实例日志投递CLS的配置

1. 接口描述

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

获取日志投递的相关配置信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBInstanceLogToCLS。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	指定实例ID。例如：cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-2gdv46zn
CLSRegion	否	String	CLS服务所在地域示例值：ap-guangzhou

3. 输出参数

参数名称	类型	描述
ErrorLog	LogToCLSConfig	实例错误日志投递配置
SlowLog	LogToCLSConfig	实例慢日志投递配置
OperationLog	LogToCLSConfig	实例操作日志投递配置
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例日志投递 CLS 的配置

输入示例

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

{
    "InstanceId": "cmgo-2gdv46zn",
    "CLSRegion": "ap-guangzhou"
}

输出示例

{
    "Response": {
        "ErrorLog": {
            "CLSRegion": "",
            "LogSetId": "",
            "LogTopicId": "",
            "Status": "OFF"
        },
        "OperationLog": {
            "CLSRegion": "",
            "LogSetId": "",
            "LogTopicId": "",
            "Status": "OFF"
        },
        "SlowLog": {
            "CLSRegion": "ap-guangzhou",
            "LogSetId": "64ae0139-0621-4e59-aba7-f60cd2264ab6",
            "LogTopicId": "6af6a321-879e-415b-b612-64dad8a3c571",
            "Status": "OFF"
        },
        "RequestId": "c11fe4ab-9d7f-4eed-bdcb-671ca55386ee"
    }
}

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.DBOperateError	内部数据存储异常。
InvalidParameterValue.NotFoundInstance	未找到实例。

查询实例日志投递CLS的配置

本页目录：