1. 接口描述
接口请求域名: dcdb.tencentcloudapi.com 。
本接口(DescribeDBLogFiles)用于获取数据库的各种日志列表,包括冷备、binlog、errlog和slowlog。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDBLogFiles。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例 ID,形如:dcdbt-ow7t8lmc。 |
ShardId | 是 | String | 分片 ID,形如:shard-7noic7tv |
Type | 是 | Integer | 请求日志类型,取值只能为1、2、3或者4。1-binlog,2-冷备,3-errlog,4-slowlog。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例 ID,形如:dcdbt-ow728lmc。 |
Type | Integer | 请求日志类型。1-binlog,2-冷备,3-errlog,4-slowlog。 |
Total | Integer | 请求日志总数 |
Files | Array of LogFileInfo | 日志文件列表 |
VpcPrefix | String | 如果是VPC网络的实例,做用本前缀加上URI为下载地址 |
NormalPrefix | String | 如果是普通网络的实例,做用本前缀加上URI为下载地址 |
ShardId | String | 分片 ID,形如:shard-7noic7tv |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取日志列表
输入示例
https://dcdb.tencentcloudapi.com/?Action=DescribeDBLogFiles
&InstanceId=dcdbt-2t4cf98d
&ShardId=shard-gdqcdn39
&Type=1
&<公共请求参数>
输出示例
{
"Response": {
"Files": [
{
"FileName": "cos_xtrabackup+1638332007+20211201+121327+2830373251+xbstream.lz4",
"Length": 5253724,
"Mtime": 1468822981,
"Uri": "/1/noshard_108/group_1520844319_37793941/1468578832/859932065/000001/5ce7d1a8f26c2dfcf1de22d4e9792b11b0b0057450684d266e1bf9a8aa6ea272/1/shard-5ps4rppj/set_1516333432_6"
}
],
"InstanceId": "dcdbt-2t4cf98d",
"ShardId": "shard-gdqcdn39",
"NormalPrefix": "http://10.66.255.253:8083",
"RequestId": "7212a9ec-a235-2144-98d4-59fbe6f14d79",
"Total": 1,
"Type": 1,
"VpcPrefix": "http://169.254.0.27:8083"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.OssOperationFailed | 请求后端接口失败。 |
InternalError.CamAuthFailed | CAM鉴权请求失败。 |
InternalError.CosConfiguration | COS地址配置错误。 |
InternalError.CosSignUrl | 备份文件签名失败。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InternalError.GetInstanceDetailFailed | 获取实例详情失败。 |
InternalError.GetInstanceInfoFailed | 获取实例信息失败。 |
InvalidParameter.GenericParameterError | 参数合法性校验错误。 |
InvalidParameter.InstanceNotFound | 未找到请求的实例。 |
ResourceNotFound.NoInstanceFound | 找不到指定的数据库实例。 |
ResourceUnavailable.CosApiFailed | COS API调用错误。 |
ResourceUnavailable.InstanceAlreadyDeleted | 数据库实例已被删除。 |
ResourceUnavailable.InstanceStatusAbnormal | 数据库实例状态不正确,当前无法操作。 |
UnauthorizedOperation.PermissionDenied | 没有权限操作该接口或资源。 |