# 获取审计日志列表-ObtainingtheAuditLogList #### 功能介绍 获取审计日志列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ListAuditlogs)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dds:instance:listAuditLog | list | instance | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | dds:instance:list | - | #### URI - URI格式 GET /v3/{project_id}/instances/{instance_id}/auditlog - URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/65d3fe0c50984b35bc1a36e9b7c7de98in02/auditlog?start_time=2020-12-06T09:00:00+0800\&end_time=2020-12-10T18:00:15+0800\&offset=0\&limit=33 表1路径参数 | 名称 | 是否必选 | 类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及 **默认取值：** 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及 **默认取值：** 不涉及。 | 表2Query参数 | 名称 | 是否必选 | 类型 | 描述 | |:---|:---|:---|:---| | node_id | 否 | String | **参数解释：** 查询审计日志的节点ID。不传值，默认查询所有的节点，集群实例审计日志分布在mongos节点上。 **约束限制：** 不涉及。 **取值范围：** 不涉及 **默认取值：** 不涉及。 | | 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。 **取值范围：** 不涉及 **默认取值：** 默认100，查询前100条实例信息。 | #### 请求参数 表3请求Header参数 | 名称 | 是否必选 | 类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及 **默认取值：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 语言。 **约束限制：** 不涉及。 **取值范围：** 不涉及 **默认取值：** 不涉及。 | #### 响应参数 表4响应Body参数 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | audit_logs | Array of objects | **参数解释：** 审计日志具体信息，请参见[表5]。 **取值范围：** 不涉及。 | | total_record | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | total_size | Long | **参数解释：** 当前实例审计日志使用总量，单位：byte。 **取值范围：** 不涉及。 | 表5audit_logs字段参数说明 | 名称 | 参数类型 | 描述 | |:---|:---|:---| | node_id | String | **参数解释：** 节点ID。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 审计日志ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 审计日志文件名。 **取值范围：** 不涉及。 | | size | Long | **参数解释：** 审计日志大小，单位：byte。 **取值范围：** 不涉及。 | | start_time | String | **参数解释：** 审计日志开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | | end_time | String | **参数解释：** 审计日志结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 **取值范围：** 不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/65d3fe0c50984b35bc1a36e9b7c7de98in02/auditlog?start_time=2020-12-06T09:00:00+0800&end_time=2020-12-10T18:00:15+0800&offset=0&limit=33 ``` #### 响应示例 ``` { "total_record" : 1, "total_size" : 2473, "audit_logs" : [ { "id" : "10190012aae94b38a10269b8ad025fc1no02_1607681849871", "name" : "0a84b6e97780d3271fd0c00f2db42932_audit_log_65d3fe0c50984b35bc1a36e9b7c7de98in02_10190012aae94b38a10269b8ad025fc1no02_1607681849871", "size" : 2473, "node_id" : "10190012aae94b38a10269b8ad025fc1no02", "start_time" : "2020-12-11T18:14:49+0800", "end_time" : "2020-12-11T18:17:25+0800" } ] } ``` #### SDK 单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。 #### 状态码 详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。 #### 错误码 详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。