文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 管理数据库和用户（PostgreSQL）/ 覆盖当前pg_hba.conf文件的配置 - AddPostgresqlHbaConf
更新时间：2026-03-16 GMT+08:00
查看PDF
分享

覆盖当前pg_hba.conf文件的配置 - AddPostgresqlHbaConf

功能介绍

全量覆盖当前pg_hba.conf文件内容，入参为空时用默认配置覆盖当前文件内容。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/hba-info

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    约束限制：

    非空。

    取值范围：

    获取方法请参见获取项目ID。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    约束限制：

    非空。

    取值范围：

    该参数值可调用查询数据库实例列表接口，通过表4中的“id”获取。

    默认取值：

    不涉及。

请求消息

表2 请求参数

参数

是否必选

参数类型

描述

数组元素

否

Array of objects

参数解释：

修改参数。

详情请参见表3。

约束限制：

不涉及。
表3 参数说明

参数

是否必选

参数类型

描述

type

是

String

参数解释：

连接类型。

约束限制：

不涉及。

取值范围：

  • host：基于客户端的IP地址或主机名来控制访问。
  • hostssl：类似于host，但客户端必须通过SSL连接。
  • hostnossl：基于客户端的IP地址或主机名，但不允许通过SSL的连接。

默认取值：

不涉及。

database

是

String

参数解释：

数据库名。

约束限制：

不涉及。

取值范围：

除template0，template1的数据库名，多个以逗号隔开。

该参数值可调用查询数据库列表接口，通过表3中的“name”获取。

默认取值：

不涉及。

user

是

String

参数解释：

除内置用户（rdsAdmin, rdsMetric, rdsBackup, rdsRepl, rdsProxy, rdsDdm, rdsDisaster）以外的用户名。

约束限制：

不涉及。

取值范围：

  • 值为all：表示当前实例的所有数据库用户。
  • 值为具体的用户名，多个以逗号隔开。

默认取值：

不涉及。

address

是

String

参数解释：

客户端IP地址。0.0.0.0/0表示允许用户从任意IP地址访问数据库。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

mask

否

String

参数解释：

掩码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

空字符串。

method

是

String

参数解释：

认证方式。

约束限制：

不涉及。

取值范围：

枚举值：reject、md5、scram-sha-256。

默认取值：

不涉及。

priority

是

Integer

参数解释：

优先级，表示配置的先后。

约束限制：

不涉及。

取值范围：

当前实例下已有的priority可调用查询实例的pg_hba.conf文件配置接口，通过表3中的“priority”获取。

默认取值：

不涉及。

请求示例

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/e28979107ed04d3b8b2f1b819b8d2be3in03/hba-info
[ { 
   "type" : "host", 
   "database" : "all", 
   "user" : "all", 
   "address" : "0.0.0.0/0", 
   "mask" : "", 
   "method" : "md5", 
   "priority" : 0 
 } ]

响应消息

  • 正常响应要素说明
    表4 要素说明

    名称

    参数类型

    说明

    code

    String

    参数解释：

    结果码。

    取值范围：

    不涉及。

    message

    String

    参数解释：

    结果描述。

    取值范围：

    不涉及。
    • 正常响应样例
    { 
  "code" : 0, 
  "message" : "" 
}

状态码

错误码

请参见错误码。

相关文档