获取慢日志下载链接 - DownloadSlowlog

功能介绍

获取慢日志下载链接。下载的日志仅包含主节点的日志。

调用接口前，您需要了解API认证鉴权。
调用接口前，您需要了解请求Header参数说明。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
rds:log:download	read	-	-	-	-

URI

URI格式
 POST /v3/{project_id}/instances/{instance_id}/slowlog-download

参数说明

表1 参数说明
名称	是否必选	说明
project_id	是	参数解释：租户在某一region下的project ID。约束限制：非空。取值范围：获取方法请参见获取项目ID。默认取值：不涉及。
instance_id	是	参数解释：实例ID。约束限制：非空。取值范围：该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。默认取值：不涉及。

请求参数

表2 参数说明
名称	是否必选	参数类型	说明
file_name	否	String	参数解释：需要下载的文件的文件名。约束限制：当引擎为SQL Server时为必选。取值范围：对于MySQL和PostgreSQL引擎，文件名称可以在控制台单击实例名称，在“日志管理 > 慢日志”页面的文件列表中获取。对于SQL Server引擎，文件名称可通过查询慢日志文件列表接口获取。默认取值：不涉及。

请求示例

获取慢日志文件“Database_slowlog_name”的下载链接。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/slowlog-download
{
	"file_name":"Database_slowlog_name"
}

响应消息

正常响应要素说明

表3 要素说明
名称	参数类型	说明
list	List	参数解释：慢日志下载链接列表，详见表4。
status	String	参数解释：慢日志下载链接生成状态。取值范围： FINISH，表示下载链接已经生成完成。 CREATING，表示正在生成文件，准备下载链接。 FAILED，表示存在日志文件准备失败。
count	Integer	参数解释：慢日志链接数量。取值范围：不涉及。

表4 linkInfo字段数据结构说明
名称	参数类型	说明
workflow_id	String	参数解释：任务ID。取值范围： MySQL引擎该字段值固定为""。
file_name	String	参数解释：生成的下载文件名。取值范围：不涉及。
status	String	参数解释：当前链接的生成状态。取值范围： EXPORTING，下载链接正在生成中。 SUCCESS，下载链接生成成功。 FAILED，下载链接生成失败。
file_size	String	参数解释：文件大小。单位：KB。取值范围：不涉及。
file_link	String	参数解释：下载链接。链接有效时间为5分钟。取值范围：不涉及。
create_at	Long	参数解释：生成时间。取值范围：不涉及。
update_at	Long	参数解释：更新时间。取值范围：不涉及。

正常响应样例

正在生成慢日志下载链接。

{
 "list": [
  {
   "workflow_id": "",
   "file_name": "2938f766224645ffa2f950f03859d66f_slowlog_download_20260310092905432",
   "status": "EXPORTING",
   "create_at": 1773134945420
  }
 ],
 "status": "CREATING",
 "count": 1
}

慢日志下载链接获取成功。

{
 "list": [
  {
   "workflow_id": "",
   "file_name": "2938f766224645ffa2f950f03859d66f_slowlog_download_20260310093235648",
   "status": "SUCCESS",
   "file_size": "3417",
   "file_link": "https://dbsbucket-****.obs.****",
   "create_at": 1773135165994
  }
 ],
 "status": "FINISH",
 "count": 1
}