实例更新白名单分组v2
更新时间 2025-09-26 14:44:11
最近更新时间: 2025-09-26 14:44:11
接口功能介绍
为文档数据库实例更新白名单分组
接口约束
无
URI
POST /DDS2/v2/openApi/updateWhiteList
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394************************* | |
| id | 是 | String | 白名单分组序号 | 380 | |
| ipType | 是 | String | ip类型，取值ipv4或者ipv6 | ipv4 | |
| ipList | 是 | String | 修改后的允许访问的白名单列表，JSON数组字符串，示例："["10.138.16.9"]" | ||
| whiteListType | 是 | String | 业务访问类型，1是内网，2是公网 | 2 | |
| groupName | 是 | String | 白名单分组名称 | groupOne |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 实例更新白名单成功 | |
| returnObj | Object | 返回对象 | ||
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 |
枚举参数
无
请求示例
请求url
无
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
{
"prodInstId":"d2b0a486681d4833a53a1e223d9fcb9f",
"id":"380",
"ipType":"ipv4",
"ipList":"[\"10.138.16.9\"]",
"groupName":"groupOne",
"whiteListType":"2"
}
响应示例
{
"statusCode": 800,
"message": "实例更新白名单成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
