Domain name for API request: tdmysql.intl.tencentcloudapi.com.
This API is used to query instance archived WAL log list.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDBSArchiveLogs. |
| Version | Yes | String | Common Params. The value used for this API: 2021-11-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID. |
| ArchiveLogId | No | Integer | Logging ID |
| EndTime | No | String | End time. |
| FilterStatus | No | String | Backup status: pending, running, success, failed |
| Limit | No | Integer | Limit on number |
| Offset | No | Integer | Offset. |
| OrderBy | No | String | Sorting field, enumerate: StartTime, EndTime, ExpiredTime, FileSize, BackupDuration |
| OrderType | No | String | Sorting method: ASC: sequential, DESC: reverse |
| StartTime | No | String | Start time. |
| Parameter Name | Type | Description |
|---|---|---|
| Items | Array of ArchiveLogModel | Archivelog list Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Total. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query instance archive log list information
POST / HTTP/1.1
Host: tdmysql.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBSArchiveLogs
<Common request parameters>
{
"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
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.DatabaseAccessError | Database access error. |
| InternalError.DescribeDBObjectsError | Query database object failed. |
| InternalError.RouterNotFound | Route not found. whether parameter passing is incorrect. |
| ResourceNotFound.BizResourceNotFoundError | Instance resource not found. |
文档反馈