1. 接口描述
接口请求域名: tdmysql.tencentcloudapi.com 。
查询实例归档日志列表 DescribeDBSArchiveLogs
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDBSArchiveLogs。 |
| Version | 是 | String | 公共参数,本接口取值:2021-11-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值:tdsql3-000d02ac |
| ArchiveLogId | 否 | Integer | 日志记录ID 示例值:7365 |
| EndTime | 否 | String | 结束时间 示例值:2025-07-30 20:00:00 |
| FilterStatus | 否 | String | 备份状态:pending,running,success,failed 示例值:success |
| Limit | 否 | Integer | 条数限制 示例值:1 |
| Offset | 否 | Integer | 偏移量 示例值:0 |
| OrderBy | 否 | String | 排序字段,枚举:StartTime,EndTime,ExpiredTime,FileSize,BackupDuration 示例值:StartTime |
| OrderType | 否 | String | 排序方式:ASC:顺序, DESC:倒序 示例值:ASC |
| StartTime | 否 | String | 开始时间 示例值:2025-07-30 20:00:00 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Items | Array of ArchiveLogModel | 归档日志列表 注意:此字段可能返回 null,表示取不到有效值。 |
| TotalCount | Integer | 总数 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例归档日志列表
查询实例归档日志列表信息
输入示例
POST / HTTP/1.1
Host: tdmysql.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBSArchiveLogs
<公共请求参数>
{
"InstanceId": "tdsql3-000d02ac",
"Limit": 1,
"Offset": 0
}
输出示例
{
"Response": {
"Items": [
{
"ArchiveLogId": 7365,
"BackupDuration": 59610,
"BackupStatus": "success",
"EndTime": "2025-07-31 16:02:34",
"ErrorMessage": "",
"ExpiredTime": "2025-08-07 16:02:34",
"FileName": "2025-07-31",
"FileSize": 397689856,
"InstanceId": "tdsql3-000d02ac",
"StartTime": "2025-07-30 23:42:34"
}
],
"RequestId": "e8f0457c-f287-45a0-b45f-a5be3ef7a30b",
"TotalCount": 8
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DatabaseAccessError | 数据库访问错误。 |
| InternalError.DescribeDBObjectsError | 查询数据库对象失败 |
| InternalError.RouterNotFound | 找不到路由,是否参数传递不对 |
| ResourceNotFound.BizResourceNotFoundError | 实例资源找不到 |