文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 日志管理/ 获取审计日志列表- ListAuditLogs
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取审计日志列表 - ListAuditLogs

功能介绍

获取审计日志列表。

调用方法

请参见如何调用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}/instances/{instance_id}/audit-logs

表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指时区偏移量，例如北京时间偏移显示为+0800。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

是

String

参数解释：

查询结束时间。

约束限制：

格式为“yyyy-mm-ddThh:mm:ssZ”， 大于查询开始时间，时间跨度不超过30天，

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

取值范围：

不涉及。

默认取值：

不涉及。

offset

是

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0

默认取值：

0

limit

是

Integer

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100

默认取值：

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参数

参数

参数类型

描述

audit_logs

Array of AuditLogDetail objects

参数解释：

记录列表。

取值范围：

不涉及。

total_count

Integer

参数解释：

总记录数。

取值范围：

不小于0。
表5 AuditLogDetail

参数

参数类型

描述

id

String

参数解释：

审计日志ID。

取值范围：

不涉及。

name

String

参数解释：

审计日志文件名。

取值范围：

不涉及。

size

Long

参数解释：

审计日志大小，单位：KB。

取值范围：

不涉及。

begin_time

String

参数解释：

审计日志开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

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

取值范围：

不涉及。

end_time

String

参数解释：

审计日志结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。

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

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/audit-logs?start_time=2018-09-15T06:25:43+0800&end_time=2018-09-16T10:40:15+0800&offset=0&limit=10

响应示例

状态码：200

Success.

{
  "audit_logs" : [ {
    "id" : "fa163ea0e2bet11e9d832166a2cf894c5br01",
    "name" : "317156_20190916032844_eb8fe5d181ec44a2850302691541f760in01_Audit_166a2cf8-d832-11e9-94c5-fa163ea0e2be",
    "size" : 20481.835938,
    "begin_time" : "2019-11-06T09:03:34+0800",
    "end_time" : "2019-11-06T10:39:15+0800"
  }, {
    "id" : "fa163ea0e2bet11e9d832136a668094c5br01",
    "name" : "317162_20190916032838_eb8fe5d181ec44a2850302691541f760in01_Audit_136a6680-d832-11e9-94c5-fa163ea0e2be",
    "size" : 20481.835938,
    "begin_time" : "2019-11-07T09:04:35+0800",
    "end_time" : "2019-11-07T10:38:16+0800"
  } ],
  "total_count" : 2
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 日志管理