文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 日志管理/ 获取全量SQL的临时下载链接- ListAuditLogDownloadLink
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取全量SQL的临时下载链接 - ListAuditLogDownloadLink

功能介绍

获取全量SQL的临时下载链接。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:auditlog:list

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/instance/{instance_id}/auditlog/download-link

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

start_time

是

String

参数解释：

开始时间。

约束限制：

格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

取值范围：

不得早于实例创建时间。

默认取值：

不涉及。

end_time

是

String

参数解释：

结束时间。

约束限制：

格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

取值范围：

不得晚于当前时间。

默认取值：

不涉及。

node_id

否

String

参数解释：

节点ID。

约束限制：

  • 若输入，则只获取该节点的全量SQL下载链接。

  • 若不输入，则获取该实例所有节点的全量SQL下载链接。

取值范围：

只能由英文字母、数字组成，前面为UUID，后缀为no07，长度为36个字符。

默认取值：

不涉及。

last_file_name

否

String

参数解释：

上次查询的最后一个文件的文件名。

约束限制：

  • 若输入，则从该文件名以后按字典顺序开始查询。

  • 若不输入，则从第一个文件开始查询。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

Integer

参数解释：

一次查询返回的文件数量。

约束限制：

不涉及。

取值范围：

1-50。

默认取值：

10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

files

Array of FileInfo objects

参数解释：

获取到的全量SQL文件信息。
表5 FileInfo

参数

参数类型

描述

name

String

参数解释：

文件名。

取值范围：

不涉及。

size

Long

参数解释：

文件大小，单位：KB。

取值范围：

不涉及。

updated_time

String

参数解释：

SQL文件最后一次修改时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始，Z指时区偏移量，例如偏移1个小时显示为+0100。

取值范围：

不涉及。

download_link

String

参数解释：

文件下载链接。

取值范围：

不涉及。

link_expired_time

String

参数解释：

下载链接过期时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

其中，T指某个时间的开始，Z指时区偏移量，例如偏移1个小时显示为+0100。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

获取全量SQL的临时下载链接。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/669a94abef9f4979b2dfba92f48f4042in07/auditlog/download-link?node_id=2e723b45786148fc94c8737f5980786cno07&last_file_name=20230724160316_99b1d48896bb44178b715d64b68603f9in07_6a21d5df9bb24f5db83121c5fec0b1d2no07_SQLAudit_8b4b53d2-29f8-11ee-92aa-fa163ef00f0d&limit=10&start_time=2023-07-24T09:27:00+0800&end_time=2023-07-25T15:00:14+0800

响应示例

状态码： 200

Success.

{
  "files" : [ {
    "name" : "20230706023359_669a94abef9f4979b2dfba92f48f4042in07_b051c8f7b98f4deeaf88ba97c8daba9dno07_SQLAudit_903bdbb6-1ba5-11ee-8b97-fa163ef0f8c2",
    "size" : 928,
    "updated_time" : "2023-07-06T02:43:57+0800",
    "download_link" : "https://obs.obs.domainname.com/bucketname/userid_instanceid/20230706/SQLAudit/xxxxxx",
    "link_expired_time" : "2023-07-13T012:30:36+0800"
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 日志管理