修改实例的IP白名单
更新时间 2026-05-06 11:06:44
最近更新时间: 2026-05-06 11:06:44
接口功能介绍
修改实例的IP白名单
接口约束
无
URI
PUT /PG/v1/white-list/modify
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Project-Id | 否 | String | 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 | 0 | |
| regionId | 是 | String | 资源池id，比如实例在资源池A，则需要填写A资源池的id。 | 81f7728662dd11ec810800155d307d5b |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例id | 129100622536654738 | |
| mode | 是 | String | 修改模式， cover(覆盖) ， append(追加) ， delete(删除,若分组下的ip被全部删除，则会将该分组也删除，默认分组(default)则会被设置成只允许本机访问，即只有127.0.0.1这个白名单ip) | cover | |
| ipList | 是 | Array of Strings | ip列表,数量限制：1-1000 | ["172.16.10.5","172.16.10.6"] | |
| groupId | 否 | Long | 分组id,不传则作用于全部分组 | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码 | 800 | |
| message | String | 消息提示 | SUCCESS | |
| error | String | 错误码 | ||
| returnObj | Object | 返回结果 |
枚举参数
无
请求示例
请求url
https://pgsql-global.ctapi.ctyun.cn/PG/v1/white-list/modify
请求头header
{
"Project-Id":"0",
"regionId":"81f7728662dd11ec810800155d307d5b"
}
请求体body
{
"prodInstId":"129100622536654738",
"mode":"append",
"ipList":[
"172.16.10.5",
"172.16.10.6"
]
}
响应示例
{
"message":"SUCCESS",
"returnObj":{
},
"statusCode":800,
"error":""
}
状态码
请参考 状态码
错误码
请参考 错误码
