1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(DescribeInstanceErrorLogs)用于查询实例错误日志列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstanceErrorLogs。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
InstanceId | 是 | String | 实例Id 示例值:cynosdbmysql-ins-4senc2fm |
Limit | 否 | Integer | 日志条数限制 示例值:20 |
Offset | 否 | Integer | 日志条数偏移量 示例值:0 |
StartTime | 否 | String | 开始时间 示例值:2022-01-02 15:04:05 |
EndTime | 否 | String | 结束时间 示例值:2022-02-02 15:04:05 |
OrderBy | 否 | String | 排序字段,有Timestamp枚举值 示例值:Timestamp |
OrderByType | 否 | String | 排序类型,有ASC,DESC枚举值 示例值:ASC |
LogLevels.N | 否 | Array of String | 日志等级,有error、warning、note三种,支持多个等级同时搜索 示例值:note |
KeyWords.N | 否 | Array of String | 关键字,支持模糊搜索 示例值:unconnected |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 日志条数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ErrorLogs | Array of CynosdbErrorLogItem | 错误日志列表 注意:此字段可能返回 null,表示取不到有效值。 示例值: ["Content": "Aborted connection 562579 to db: 'unconnected' user: 'unauthenticated' host: '169...*' (Got an error reading communication packets)","Level": "note","Timestamp": 1730182001}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询错误日志
查询错误日志
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceErrorLogs
<公共请求参数>
{
"InstanceId": "cynosdbmysql-ins-m6f0hkkd",
"Limit": 1,
"Offset": 0,
"StartTime": "2024-10-28 10:19:21",
"EndTime": "2024-10-28 10:20:01",
"OrderBy": "Timestamp",
"OrderByType": "DESC",
"LogLevels": [
"note"
],
"KeyWords": [
"unconnected"
]
}
输出示例
{
"Response": {
"ErrorLogs": [
{
"Content": "Aborted connection 562579 to db: 'unconnected' user: 'unauthenticated' host: '169.214.18.1' (Got an error reading communication packets)",
"Level": "note",
"Timestamp": 1730182001
}
],
"RequestId": "32f291cb-38c8-4a0c-8fd0-5a4c370ac6df",
"TotalCount": 3
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.OperationFailedError | 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InternalError.SystemError | 系统内部错误。 |
InvalidParameter.ControllerNotFoundError | 未找到该接口。 |
InvalidParameterValue.InstanceNotFound | 实例不存在。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
InvalidParameterValue.ValueNotFound | 未找到该数据。 |
UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |