1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
根据检索条件查询实例错误日志详情。只能查询一个月之内的错误日志。
使用时需要注意:可能存在单条错误日志太大,导致整个http请求的回包太大,进而引发接口超时。一旦发生超时,建议您缩小查询时的Limit参数值,从而降低包的大小,让接口能够及时返回内容。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeErrorLogData。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID 。 示例值:cdb-c1nl9rpv |
StartTime | 是 | Integer | 开始时间戳。例如 1585142640 。 示例值:1585142640 |
EndTime | 是 | Integer | 结束时间戳。例如 1585142640 。 示例值:1585142640 |
KeyWords.N | 否 | Array of String | 要匹配的关键字列表,最多支持15个关键字。 示例值:["keywords0\n"] |
Limit | 否 | Integer | 分页的返回数量,默认为100,最大为400。 示例值:400 |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
InstType | 否 | String | 仅在实例为主实例或者灾备实例时生效,可选值:slave,代表拉取从机的日志。 示例值:"" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的记录总数。 示例值:1 |
Items | Array of ErrlogItem | 返回的记录。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例错误日志
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeErrorLogData
<公共请求参数>
{
"InstanceId": "cdb-c1nl9rpv",
"Limit": "400",
"StartTime": "1585142640",
"Offset": "0",
"KeyWords": [
"keywords0"
],
"EndTime": "1585142640"
}
输出示例
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"TotalCount": 1,
"Items": [
{
"Content": "show master status",
"Timestamp": 1585142640
}
]
}
}
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.QueryLogError | 查询日志失败。 |
FailedOperation.TimeoutError | 查询超时。 |
InternalError.DBError | 数据库异常。 |
InternalError.DBOperationError | 数据库操作失败。 |
InternalError.DBRecordNotExistError | 数据库实例不存在。 |
InternalError.InternalHttpServerError | 请求执行异常。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InstanceNotFound | 实例不存在。 |
InvalidParameter.InvalidParameterError | 无效的参数值。 |
InvalidParameterValue.DataConvertError | 数据转换失败。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ResultOverLimit | 结果集超过限制,请缩小检索范围。 |
ResourceNotFound.CdbInstanceNotFoundError | 未找到数据库实例,请确认您的实例状态是否正常。 |