getConfig

语法

getConfig([key])

详情

获取系统配置信息。

系统内部将配置项按安全级别划分为敏感、标准和不敏感三类。

  • 敏感配置项:clusterReplicationExecutionPassword、s3SecretAccessKey、metricsToken。
  • 不敏感配置项:webLoginRequired、webModules。
  • 标准配置项:除上述两类之外的其他配置。

当启用配置访问控制(enableConfigAccessControl=true)时,函数仅返回当前用户有权限访问的配置项;若未启用访问控制,则不进行权限验证。

不同用户权限说明

用户角色 不敏感配置 标准配置 敏感配置
未登录用户 可以查看 不能查看 不能查看
普通用户 可以查看 可以查看 不能查看
管理员用户 可以查看 可以查看 不能查看

参数

key 是一个字符串,表示配置参数名称,为可选参数。

返回值

  • 若不指定 key,返回一个字典,包含当前用户有权限读取的所有配置项及其对应值。
  • 若指定 key
    • 若为有效配置参数且用户具有读取权限,返回字符串标量或向量,表示配置值;
    • 若不是配置参数,或是有效配置但用户没有读取权限,则返回空值。