---
title: "获取配置文件内容"
method: POST
path: "/system/getSystemConfig"
tags: ["System"]
---

# 获取配置文件内容

`POST /system/getSystemConfig`

## Response `200`

获取配置文件内容,返回包括系统配置

- object
  - `code` integer
  - `data` ResponseSysConfigResponse
    - `config` ConfigServer
      - `aliyun-oss` ConfigAliyunOSS
        - `access-key-id` string
        - `access-key-secret` string
        - `base-path` string
        - `bucket-name` string
        - `bucket-url` string
        - `endpoint` string
      - `autocode` ConfigAutocode
        - `ai-path` string
        - `module` string
        - `root` string
        - `server` string
        - `web` string
      - `aws-s3` ConfigAwsS3
        - `base-url` string
        - `bucket` string
        - `disable-ssl` boolean
        - `endpoint` string
        - `path-prefix` string
        - `region` string
        - `s3-force-path-style` boolean
        - `secret-id` string
        - `secret-key` string
      - `captcha` ConfigCaptcha
        - `img-height` integer — 验证码高度
        - `img-width` integer — 验证码宽度
        - `key-long` integer — 验证码长度
        - `open-captcha` integer — 防爆破验证码开启此数，0代表每次登录都需要验证码，其他数字代表错误密码此数，如3代表错误三次后出现验证码
        - `open-captcha-timeout` integer — 防爆破验证码超时时间，单位：s(秒)
      - `cloudflare-r2` ConfigCloudflareR2
        - `access-key-id` string
        - `account-id` string
        - `base-url` string
        - `bucket` string
        - `path` string
        - `secret-access-key` string
      - `cors` ConfigCORS
        - `mode` string
        - `whitelist` ConfigCORSWhitelist[]
          - `allow-credentials` boolean
          - `allow-headers` string
          - `allow-methods` string
          - `allow-origin` string
          - `expose-headers` string
      - `db-list` ConfigSpecializedDB[]
        - `alias-name` string
        - `config` string — 高级配置
        - `db-name` string — 数据库名
        - `disable` boolean
        - `engine` string — 数据库引擎，默认InnoDB
        - `log-mode` string — 是否开启Gorm全局日志
        - `log-zap` boolean — 是否通过zap写入日志文件
        - `max-idle-conns` integer — 空闲中的最大连接数
        - `max-open-conns` integer — 打开到数据库的最大连接数
        - `password` string — 数据库密码
        - `path` string — 数据库地址
        - `port` string — 数据库端口
        - `prefix` string — 数据库前缀
        - `singular` boolean — 是否开启全局禁用复数，true表示开启
        - `type` string
        - `username` string — 数据库账号
      - `disk-list` ConfigDiskList[]
        - `mount-point` string
      - `email` GithubComFlippedAuroraGinVueAdminServerConfigEmail
        - `from` string — 发件人 你自己要发邮件的邮箱
        - `host` string — 服务器地址 例如 smtp.qq.com 请前往QQ或者你要发邮件的邮箱查看其smtp协议
        - `is-ssl` boolean — 是否SSL 是否开启SSL
        - `nickname` string — 昵称 发件人昵称 通常为自己的邮箱
        - `port` integer — 端口 请前往QQ或者你要发邮件的邮箱查看其smtp协议 大多为 465
        - `secret` string — 密钥 用于登录的密钥 最好不要用邮箱密码 去邮箱smtp申请一个用于登录的密钥
        - `to` string — 收件人:多个以英文逗号分隔 例：a@qq.com b@qq.com 正式开发中请把此项目作为参数使用
      - `excel` ConfigExcel
        - `dir` string
      - `hua-wei-obs` ConfigHuaWeiObs
        - `access-key` string
        - `bucket` string
        - `endpoint` string
        - `path` string
        - `secret-key` string
      - `jwt` ConfigJWT
        - `buffer-time` string — 缓冲时间
        - `expires-time` string — 过期时间
        - `issuer` string — 签发者
        - `signing-key` string — jwt签名
      - `local` ConfigLocal
        - `path` string — 本地文件访问路径
        - `store-path` string — 本地文件存储路径
      - `mongo` ConfigMongo
        - `auth-source` string — 验证数据库
        - `coll` string — collection name
        - `connect-timeout-ms` integer — 连接超时时间
        - `database` string — database name
        - `hosts` ConfigMongoHost[] — 主机列表
          - `host` string — ip地址
          - `port` string — 端口
        - `is-zap` boolean — 是否开启zap日志
        - `max-pool-size` integer — 最大连接池
        - `min-pool-size` integer — 最小连接池
        - `options` string — mongodb options
        - `password` string — 密码
        - `socket-timeout-ms` integer — socket超时时间
        - `username` string — 用户名
      - `mssql` ConfigMssql
        - `config` string — 高级配置
        - `db-name` string — 数据库名
        - `engine` string — 数据库引擎，默认InnoDB
        - `log-mode` string — 是否开启Gorm全局日志
        - `log-zap` boolean — 是否通过zap写入日志文件
        - `max-idle-conns` integer — 空闲中的最大连接数
        - `max-open-conns` integer — 打开到数据库的最大连接数
        - `password` string — 数据库密码
        - `path` string — 数据库地址
        - `port` string — 数据库端口
        - `prefix` string — 数据库前缀
        - `singular` boolean — 是否开启全局禁用复数，true表示开启
        - `username` string — 数据库账号
      - `mysql` ConfigMysql
        - `config` string — 高级配置
        - `db-name` string — 数据库名
        - `engine` string — 数据库引擎，默认InnoDB
        - `log-mode` string — 是否开启Gorm全局日志
        - `log-zap` boolean — 是否通过zap写入日志文件
        - `max-idle-conns` integer — 空闲中的最大连接数
        - `max-open-conns` integer — 打开到数据库的最大连接数
        - `password` string — 数据库密码
        - `path` string — 数据库地址
        - `port` string — 数据库端口
        - `prefix` string — 数据库前缀
        - `singular` boolean — 是否开启全局禁用复数，true表示开启
        - `username` string — 数据库账号
      - `oracle` ConfigOracle
        - `config` string — 高级配置
        - `db-name` string — 数据库名
        - `engine` string — 数据库引擎，默认InnoDB
        - `log-mode` string — 是否开启Gorm全局日志
        - `log-zap` boolean — 是否通过zap写入日志文件
        - `max-idle-conns` integer — 空闲中的最大连接数
        - `max-open-conns` integer — 打开到数据库的最大连接数
        - `password` string — 数据库密码
        - `path` string — 数据库地址
        - `port` string — 数据库端口
        - `prefix` string — 数据库前缀
        - `singular` boolean — 是否开启全局禁用复数，true表示开启
        - `username` string — 数据库账号
      - `pgsql` ConfigPgsql
        - `config` string — 高级配置
        - `db-name` string — 数据库名
        - `engine` string — 数据库引擎，默认InnoDB
        - `log-mode` string — 是否开启Gorm全局日志
        - `log-zap` boolean — 是否通过zap写入日志文件
        - `max-idle-conns` integer — 空闲中的最大连接数
        - `max-open-conns` integer — 打开到数据库的最大连接数
        - `password` string — 数据库密码
        - `path` string — 数据库地址
        - `port` string — 数据库端口
        - `prefix` string — 数据库前缀
        - `singular` boolean — 是否开启全局禁用复数，true表示开启
        - `username` string — 数据库账号
      - `qiniu` ConfigQiniu
        - `access-key` string — 秘钥AK
        - `bucket` string — 空间名称
        - `img-path` string — CDN加速域名
        - `secret-key` string — 秘钥SK
        - `use-cdn-domains` boolean — 上传是否使用CDN上传加速
        - `use-https` boolean — 是否使用https
        - `zone` string — 存储区域
      - `redis` ConfigRedis
        - `addr` string — 服务器地址:端口
        - `clusterAddrs` string[] — 集群模式下的节点地址列表
        - `db` integer — 单实例模式下redis的哪个数据库
        - `password` string — 密码
        - `useCluster` boolean — 是否使用集群模式
      - `sqlite` ConfigSqlite
        - `config` string — 高级配置
        - `db-name` string — 数据库名
        - `engine` string — 数据库引擎，默认InnoDB
        - `log-mode` string — 是否开启Gorm全局日志
        - `log-zap` boolean — 是否通过zap写入日志文件
        - `max-idle-conns` integer — 空闲中的最大连接数
        - `max-open-conns` integer — 打开到数据库的最大连接数
        - `password` string — 数据库密码
        - `path` string — 数据库地址
        - `port` string — 数据库端口
        - `prefix` string — 数据库前缀
        - `singular` boolean — 是否开启全局禁用复数，true表示开启
        - `username` string — 数据库账号
      - `system` ConfigSystem
        - `addr` integer — 端口值
        - `db-type` string — 数据库类型:mysql(默认)|sqlite|sqlserver|postgresql
        - `iplimit-count` integer
        - `iplimit-time` integer
        - `oss-type` string — Oss类型
        - `router-prefix` string
        - `use-mongo` boolean — 使用mongo
        - `use-multipoint` boolean — 多点登录拦截
        - `use-redis` boolean — 使用redis
      - `tencent-cos` ConfigTencentCOS
        - `base-url` string
        - `bucket` string
        - `path-prefix` string
        - `region` string
        - `secret-id` string
        - `secret-key` string
      - `zap` ConfigZap
        - `director` string — 日志文件夹
        - `encode-level` string — 编码级
        - `format` string — 输出
        - `level` string — 级别
        - `log-in-console` boolean — 输出控制台
        - `prefix` string — 日志前缀
        - `retention-day` integer — 日志保留天数
        - `show-line` boolean — 显示行
        - `stacktrace-key` string — 栈名
  - `msg` string

---

[API](https://skmtc.net/fisco-bcos/apis/gin-vue-admin-swagger-api.md) · [All operations](https://skmtc.net/fisco-bcos/apis/gin-vue-admin-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fisco-bcos/gin-vue-admin-swagger-api/revisions/83281ff551eb/schema)
