DescribeAuditFiles
调用DescribeAuditFiles接口查询MongoDB实例的审计日志文件。
本接口适用于副本集实例和分片集群实例,暂不支持单节点实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAuditFiles |
要执行的操作,取值:DescribeAuditFiles。 |
DBInstanceId | String | 是 | dds-bpxxxxxxxx |
实例ID。 |
NodeId | String | 否 | d-bpxxxxxxxx |
分片集群实例中Mongos节点ID或Shard节点ID。 说明 如不传入则返回所有Mongos节点和Shard节点的审计日志。
|
PageSize | Integer | 否 | 30 |
每页记录数,取值: 30、50、100,默认值为30。 |
PageNumber | Integer | 否 | 1 |
页码,取值为大于0且不超过Integer数据类型的的最大值,默认值为1。 |
RegionId | String | 否 | cn-hangzhou |
实例所属的地域ID,您可以通过调用DescribeDBInstanceAttribute进行查询。 |
AccessKeyId | String | 否 | LTAIgbTGpxxxxxx |
阿里云颁发给用户的访问服务所用的密钥ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Items |
审计文件信息列表。 |
||
FileID | Integer | 406505 |
文件ID。 |
LogDownloadURL | String | http://xxxxxxxx.oss-cn-hangzhou.aliyuncs.com/custinsxxxxxx/custinsxxxxxx_xxxxxx.csv |
审计日志文件的下载链接。 说明 若当前不可下载,则为空串。
|
LogEndTime | String | 2019-03-12T09:23:15Z |
审计日志结束时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。 |
LogSize | Long | 98 |
审计日志文件的大小,单位为Byte。 |
LogStartTime | String | 2019-03-11T08:19:29Z |
审计日志起始时间,格式为yyyy-MM-ddTHH:mmZ(UTC时间)。 |
LogStatus | String | Success |
审计日志文件状态。
|
PageNumber | Integer | 1 |
页码。 |
PageRecordCount | Integer | 1 |
当前页记录数。 |
RequestId | String | F8CA8312-530A-413A-9129-F2BB32A8D404 |
请求ID。 |
TotalRecordCount | Integer | 1 |
总记录数。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=DescribeAuditFiles
&DBInstanceId=dds-bpxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<DescribeAuditFilesResponse>
<Items>
<LogFile>
<LogStartTime>2019-03-11T08:19:29Z</LogStartTime>
<LogEndTime>2019-03-12T09:23:15Z</LogEndTime>
<LogStatus>Success</LogStatus>
<FileID>406505</FileID>
<LogDownloadURL>http://xxxxxxxx.oss-cn-hangzhou.aliyuncs.com/custinsxxxxxx/custinsxxxxxx_xxxxxx.csv</LogDownloadURL>
<LogSize>98</LogSize>
</LogFile>
</Items>
<PageNumber>1</PageNumber>
<TotalRecordCount>1</TotalRecordCount>
<RequestId>F8CA8312-530A-413A-9129-F2BB32A8D404</RequestId>
<PageRecordCount>1</PageRecordCount>
</DescribeAuditFilesResponse>
JSON
格式
{
"Items":{
"LogFile":[
{
"LogStartTime":"2019-03-11T08:19:29Z",
"LogEndTime":"2019-03-12T09:23:15Z",
"LogStatus":"Success",
"FileID":406505,
"LogDownloadURL":"http://xxxxxxxx.oss-cn-hangzhou.aliyuncs.com/custinsxxxxxx/custinsxxxxxx_xxxxxx.csv",
"LogSize":98
}
]
},
"TotalRecordCount":1,
"PageNumber":1,
"RequestId":"F8CA8312-530A-413A-9129-F2BB32A8D404",
"PageRecordCount":1
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBInstanceClass.NotFound | Specified DB instance class is not found. | 该实例规格不存在,请您检查输入的参数是否正确。 |
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 当前的实例类型不支持此操作。 |
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论