调用DescribeMongoDBLogConfig查看云数据库MongoDB审计日志的配置。

本接口适用于规格类型为通用型本地盘版独享型本地盘版实例。

您可以根据业务需求开通云数据库MongoDB审计日志功能,开通方法请参见开通审计日志

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMongoDBLogConfig

系统规定参数。取值:DescribeMongoDBLogConfig

RegionId String cn-hangzhou

实例所属的地域ID。您可以通过调用DescribeDBInstanceAttribute进行查询。

DBInstanceId String dds-bp12c5b040dc****

实例ID。您可以通过调用DescribeDBInstances进行查询。

返回数据

名称 类型 示例值 描述
UserProjectName String nosql-176498472570****-cn-hangzhou

审计日志的project名称。

RequestId String 664ECE26-658A-47C5-88F6-870B0132E8D2

请求ID。

IsUserProjectLogstoreExist Integer 1

当前地域中是否存在审计日志的project。取值:

  • 1:存在。
  • 0null:不存在。
IsEtlMetaExist Integer 1

是否已创建将审计日志分发到Logtail的规则。关于Logtail的详细信息,请参见Logtail简介。取值:

  • 1:已创建。
  • 0null:未创建。
ServiceType String Standard

审计日志的版本类型。

  • Trail:免费试用版。
  • Standard:正式版。
EnableAudit Boolean true

是否开启云数据库MongoDB审计日志功能。

  • true:开启。
  • false:未开启。
TtlForTrail Long 1

免费试用版审计日志的保留时长。

UsedStorageForTrail Long 12548178759

免费试用版审计日志已使用的存储容量,单位为字节。

PreserveStorageForTrail Long 107374182400

免费试用版审计日志可使用存储容量的上限,单位为字节。可设置最高上限为107374182400字节。

TtlForStandard Long 30

正式版审计日志的保留时长,取值范围为1~365天。

UsedStorageForStandard Long 20163

正式版审计日志已使用的存储容量,单位为字节。

PreserveStorageForStandard Long -1

正式版审计日志可使用存储容量的上限。如果值为-1,说明未设置上限。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeMongoDBLogConfig
&DBInstanceId=dds-bp12c5b040dc****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMongoDBLogConfigResponse>
    <EnableAudit>true</EnableAudit>
    <TtlForStandard>30</TtlForStandard>
    <PreserveStorageForStandard>-1</PreserveStorageForStandard>
    <UserProjectName>nosql-1764984725705461-cn-hangzhou</UserProjectName>
    <RequestId>58E34DEE-EF44-5A59-B83E-A5B6F82CF5C9</RequestId>
    <ServiceType>Standard</ServiceType>
    <IsUserProjectLogstoreExist>1</IsUserProjectLogstoreExist>
    <UsedStorageForTrail>12565942384</UsedStorageForTrail>
    <PreserveStorageForTrail>107374182400</PreserveStorageForTrail>
    <IsEtlMetaExist>1</IsEtlMetaExist>
    <TtlForTrail>30</TtlForTrail>
    <UsedStorageForStandard>20163</UsedStorageForStandard>
</DescribeMongoDBLogConfigResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EnableAudit" : true,
  "TtlForStandard" : 30,
  "PreserveStorageForStandard" : -1,
  "UserProjectName" : "nosql-1764984725705461-cn-hangzhou",
  "RequestId" : "58E34DEE-EF44-5A59-B83E-A5B6F82CF5C9",
  "ServiceType" : "Standard",
  "IsUserProjectLogstoreExist" : 1,
  "UsedStorageForTrail" : 12565942384,
  "PreserveStorageForTrail" : 107374182400,
  "IsEtlMetaExist" : 1,
  "TtlForTrail" : 30,
  "UsedStorageForStandard" : 20163
}

错误码

访问错误中心查看更多错误码。