實例添加白名單分組v2
更新時間 2025-09-26 14:43:53
最近更新時間: 2025-09-26 14:43:53
分享文章
接口功能介紹
為文檔數據庫實例添加白名單分組
接口約束
無
URI
POST /DDS2/v2/openApi/addWhiteList
路徑參數 無
Query參數 無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 項目id | 0 | |
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文檔數據庫對外的實例標識 | 60d420bffb394************************* | |
| groupName | 是 | String | 白名單分組名 | whiteGroup1 | |
| ipType | 是 | String | ip類型，取值ipv4或者ipv6 | ipv4 | |
| ipList | 是 | String | 允許訪問的白名單列表，JSON數組字符串,示例："["10.138.16.8"]" | ||
| whiteListType | 是 | String | 業務訪問類型，1是內網，2是公網 | 2 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應碼 取值范圍：800為成功，900為失敗 | 800 | |
| message | String | 響應信息 | 實例添加白名單成功 | |
| returnObj | Object | 返回對象 | ||
| error | String | 錯誤碼。當接口失敗時才返回具體錯誤編碼，成功不返回或者為空。 |
枚舉參數
無
請求示例
請求url
無
請求頭header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
請求體body
{
"prodInstId":"d2b0a486681d4833a53a1e223d9fcb9f",
"groupName":"whiteGroup1",
"ipType":"ipv4",
"ipList":"[\"10.138.16.8\"]",
"whiteListType":"2"
}
響應示例
{
"statusCode": 800,
"message": "實例添加白名單成功",
"returnObj": {}
}
狀態碼
請參考
錯誤碼
請參考
