接口描述
修改实例的pg_hba.conf文件参数。
请确保当前实例处于运行状态,否则将修改失败。
请求方法
POST
URI
/v1/inst-user/hba-config
请求参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | Long | 实例id | 34 | |
opType | 是 | String | 操作类型,可取值范围: 1. add: 添加一行记录; 2.delete:删除一行记录; 3.modify:修改指定行的某些参数值 |
add | |
line | 否 | Integer | 需修改记录所在的行,可通过 【查询PostgreSQL实例的pg_hba.conf 文件的配置】 接口查看记录所在行。 当opType为add时,line被忽略;其他情况line不能为空, 且指定的行不能是系统内置账号的记录。 |
31 | |
items | 否 | Map | 需修改的参数值,取值规范请参考下面items表。 当opType为add时,items不能为空且需包含全部属性; 当opType为modify时,items不能为空且需包含至少一个属性; 当opType为delete时,items可为空且被忽略 |
"items":{ "type":"host", "username":"test,usertest", "database":"test,test2" } | items表 |
items
键 | 说明 |
---|---|
type | 连接类型。支持配置以下取值: 1. host :该条记录验证TCP/IP连接,包括SSL连接和非SSL连接。 2. hostssl :该条记录只验证通过SSL建立的TCP/IP连接。 3. hostnossl :该条记录只验证通过非SSL建立的TCP/IP连接。 |
database | 数据库名。 表示允许用户访问的数据库,all表示允许用户访问所有数据库。如果配置多个,可通过逗号(,)分隔。 |
username | 允许哪些用户访问数据库,填写实例的用户名。 如果配置多个,可通过逗号(,)分隔。系统内置账号不允许配置,仅能配置用户自创建账号 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码 | 800 | |
message | String | 消息提示 | SUCCESS | |
returnObj | Object | 返回对象 |
示例
请求示例
{URI}?/v1/inst-user/hba-config
{
"prodInstId":34,
"opType":"modify",
"line":10,
"items":{
"type":"host",
"username":"test,usertest",
"database":"test,test2"
}
}
响应示例
{
"returnObj": {},
"message":"SUCCESS",
"statusCode": 800
}
错误码
访问ErrorCodes说明文档查看更多错误码。