查询DDL下载日志列表 - ListDdlLogs

功能介绍

查询指定实例的DDL下载日志列表。

调用方法

请参见如何调用API。

授权信息

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

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

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbformysql:log:list	List	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:log:list	-

URI

GET /v3/{project_id}/instances/{instance_id}/ddl-log

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的project ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID，此参数是实例的唯一标识。获取方法请参见查询实例列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
node_id	是	String	参数解释：实例下的节点ID。获取方法请参见查询实例详情信息。约束限制：不涉及。取值范围：只能由英文字母、数字组成，前面为UUID，后缀为no07，长度为36个字符。默认取值：不涉及。
offset	否	Integer	参数解释：索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。约束限制：必须为整数，不能为负数。取值范围： ≥0。默认取值： 0。
limit	否	Integer	参数解释：每页显示的记录数。约束限制：不涉及。取值范围： 1-100。默认取值： 10。
start_time	否	String	参数解释：开始日期。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
end_time	否	String	参数解释：结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表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参数
参数	参数类型	描述
ddl_logs	Array of DdlLogInfo objects	参数解释： DDL下载日志列表。
total_count	Integer	参数解释：总条数。取值范围：不涉及。
keep_days	Integer	参数解释：日志保留天数。取值范围：不涉及。
switch_status	String	参数解释： DDL日志下载开关状态。取值范围： ON：开启。 OFF：关闭。

表5 DdlLogInfo
参数	参数类型	描述
id	String	参数解释：日志文件ID。取值范围：不涉及。
file_name	String	参数解释：日志文件名称。取值范围：不涉及。
file_size	Integer	参数解释：日志文件大小，单位为字节。取值范围：不涉及。
create_time	String	参数解释：日志文件上传的创建时间。取值范围：不涉及。
end_time	String	参数解释：日志文件上传的结束时间。取值范围：不涉及。
status	String	参数解释：日志文件的状态。取值范围： Active：日志文件状态正常。 Disable：日志文件不可用。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码：500

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

查询DDL下载日志列表。

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7e8dfe8f580043d4a424f65b51c0e1f0in07/ddl-log&node_id=3f84063164ee4a308d02a050234d32e3no07&offset=0&limit=10

响应示例

状态码：200

Success.

{
  "download_files" : [ {
    "id" : "a193e8a9f1cdt49d886153ced55b5b661br07",
    "file_name" : "20260325190036_OmaLog",
    "file_size" : 1024000,
    "create_time" : "2026-03-25 12:00:00",
    "end_time" : "2026-03-25 13:00:00",
    "status" : "Active"
  }, {
    "id" : "3f18b461f8a8t4a4539b2a76151bbb0b0br07",
    "file_name" : "20260325150000_OmaLog",
    "file_size" : 1844832,
    "create_time" : "2026-03-25 06:59:34",
    "end_time" : "2026-03-25 07:59:29",
    "status" : "Active"
  } ],
  "keep_days" : 7,
  "switch_status" : true,
  "total_count" : 2
}