调用DescribeAuditPolicy接口查询MongoDB实例的审计日志是否开启。
- 调用本接口时,要求实例状态为运行中。
- 本接口适用于副本集实例和分片集群实例,暂不支持单节点实例。
- 本接口限制每分钟调用30次,如超过这个限制会被限流,请勿高频调用。如需高频调用,请使用Logstore,详情请参见管理Logstore。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeAuditPolicy | 要执行的操作,取值: DescribeAuditPolicy。 |
DBInstanceId | String | 是 | dds-bpxxxxxxxx | 实例ID。 |
RegionId | String | 否 | cn-hangzhou | 实例所属的地域ID,您可以调用DescribeDBInstanceAttribute接口查询。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
LogAuditStatus | String | Enable | 审计日志的状态。
默认为关闭状态。 |
RequestId | String | 111E7B16-0A87-4CBA-B271-F34AD61E099F | 请求ID。 |
示例
请求示例
http(s)://mongodb.aliyuncs.com/?Action=DescribeAuditPolicy &DBInstanceId=dds-bpxxxxxxxx &<公共请求参数>
正常返回示例
XML
格式
<DescribeAuditPolicyResponse> <LogAuditStatus>Enable</LogAuditStatus> <RequestId>111E7B16-0A87-4CBA-B271-F34AD61E099F</RequestId> </DescribeAuditPolicyResponse>
JSON
格式
{ "LogAuditStatus": "Enable", "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F" }
错误码
访问错误中心查看更多错误码。