文档中心>API 中心>云数据库 MySQL>日志相关接口>查询实例日志投递CLS的配置

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

最近更新时间:2024-03-12 01:13:22

我的收藏

1. 接口描述

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

本接口(DescribeDBInstanceLogToCLS)用于查询实例慢日志、错误日志投递CLS的配置,通过AppId、Region以及实例ID过滤出当前实例日志投递CLS的配置。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceLogToCLS。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:cdb-r1ok5w15
ClsRegion String CLS服务所在地域
示例值:ap-guangzhou

3. 输出参数

参数名称 类型 描述
ErrorLog LogToCLSConfig 错误日志投递CLS配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Status": "ON","LogSetId":"xxx","LogTopicId":"xxx"}
SlowLog LogToCLSConfig 慢日志投递CLS配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Status": "ON","LogSetId":"xxx","LogTopicId":"xxx"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

实例日志管理中,慢日志、错误日志投递CLS的配置

输入示例

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

{
    "InstanceId": "cdb-70zdmgg1"
}

输出示例

{
    "Response": {
        "ErrorLog": {
            "Status": "ON",
            "LogSetId": "test",
            "LogTopicId": "test"
        },
        "SlowLog": {
            "Status": "OFF",
            "LogSetId": "test",
            "LogTopicId": "test"
        },
        "RequestId": "8a96c7fec3c747adb83cb0868c0107d5"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.TimeoutError 查询超时。
InternalError.CauthError 鉴权失败。
InternalError.UnknownError 未知错误。
InvalidParameter.ControllerNotFoundError 未找到该接口。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied.OperationDeniedError 操作拒绝。
OperationDenied.ResourceNotFundError 资源未找到。