修改實例的pg_hba.conf文件參數
更新時間 2022-10-28 18:32:06
最近更新時間: 2022-10-28 18:32:06
分享文章
接口描述
修改實例的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說明文檔查看更多錯誤碼。