文档首页/ 文档数据库服务 DDS/ API参考（联盟区域）/ API v3（推荐）/ 实例管理/ 查询LTS日志配置信息
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

查询LTS日志配置信息

接口说明

查询LTS日志配置信息。

约束说明

当前只支持审计日志。

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/logs/lts-configs

  • URI样例

    表1 路径参数

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

    租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。
    表2 Query参数

    参数

    是否必选

    参数类型

    描述

    offset

    否

    Integer

    索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

    limit

    否

    Integer

    查询记录数。取值范围：0~50。不传该参数时，默认查询前50条实例的云服务日志配置信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。
  • 请求示例

    无。

响应参数

表4 响应Body参数

参数

参数类型

说明

instance_lts_configs

Array of 表5 objects

每个实例的LTS日志配置信息和实例简要信息。

total_count

Integer

全部可查询的云服务日志配置结果个数，等于所有DDS实例的个数。
表5 instance_lts_configs

参数

参数类型

说明

instance

表6 object

实例的简要信息。

lts_configs

Array of 表 lts_configs objects

LTS日志配置明细。从未设置LTS日志流，不返回该字段。
表6 instance

参数

参数类型

说明

id

String

实例ID。

name

String

实例名字。

mode

String

实例类型，对应副本集，集群两种。

枚举值：

  • Replica
  • Sharding

datastore

表7 object

实例的数据库引擎和版本。

status

String

实例状态。

enterprise_project_id

String

实例归属的企业项目ID，如果是default企业项目，值为0，如果是其他企业项目，请参考企业项目相关内容。

actions

Array of strings

实例所有正在执行的动作。
表7 datastore

参数

参数类型

说明

type

String

数据库引擎，值为mongodb。

枚举值：

  • mongodb

version

String

数据库大版本。
表8 lts_configs

参数

参数类型

说明

log_type

String

LTS日志类型，不能为空，具有以下日志类型。

  • audit_log

枚举值：

  • audit_log

lts_group_id

String

云日志服务LTS日志组ID。

lts_stream_id

String

云日志服务LTS日志流ID。

enabled

Boolean

是否上传。
  • 响应示例 
    { 
  "total_count" : 1, 
  "instance_lts_configs" : [ { 
    "instance" : { 
      "id" : "520c58ba00a3497e97ce0b9604874dd6in02", 
      "name" : "dds-1f84", 
      "mode" : "replica", 
      "datastore" : { 
        "type" : "mongodb", 
        "version" : 4.0 
      }, 
      "status" : "normal", 
      "enterprise_project_id" : "0", 
      "actions" : [ "OPS_AUDIT_LOG" ] 
    }, 
    "lts_configs" : [ { 
      "log_type" : "audit_log", 
      "lts_group_id" : "ec6dc499-1a63-4229-a0c2-a2afa8bcfc95", 
      "lts_stream_id" : "cae69d2e-378b-41dd-b3c9-3ca1cd5335bc", 
      "enabled" : true 
    } ] 
  } ] 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 实例管理