全部产品
Search
文档中心

云数据库 MongoDB:DescribeMongoDBLogConfig - 查看日志服务的配置

更新时间:Jan 17, 2023

查看MongoDB日志服务的配置。

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 访问级别 资源类型 条件关键字 关联操作
dds:DescribeMongoDBLogConfig READ
  • MongoDB
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称 类型 必填 描述 示例值
DBInstanceId string

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

dds-bp12c5b040dc****

返回参数

名称 类型 描述 示例值
object

审计日志的配置信息。

UserProjectName string

审计日志的project名称。

nosql-176498472570****-cn-hangzhou
RequestId string

请求ID。

664ECE26-658A-47C5-88F6-870B0132E8D2
IsUserProjectLogstoreExist integer

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

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

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

  • 1:已创建。
  • 0null:未创建。
1
ServiceType string

审计日志的版本类型。

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

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

  • true:开启。
  • false:未开启。
true
TtlForTrail long

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

1
UsedStorageForTrail long

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

12548178759
PreserveStorageForTrail long

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

107374182400
TtlForStandard long

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

30
UsedStorageForStandard long

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

20163
PreserveStorageForStandard long

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

-1

示例

正常返回示例

JSON格式

{
  "UserProjectName": "nosql-176498472570****-cn-hangzhou",
  "RequestId": "664ECE26-658A-47C5-88F6-870B0132E8D2",
  "IsUserProjectLogstoreExist": 1,
  "IsEtlMetaExist": 1,
  "ServiceType": "Standard",
  "EnableAudit": true,
  "TtlForTrail": 1,
  "UsedStorageForTrail": 12548178759,
  "PreserveStorageForTrail": 107374182400,
  "TtlForStandard": 30,
  "UsedStorageForStandard": 20163,
  "PreserveStorageForStandard": -1
}

错误码

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