文档

ModifySecurityIps - 修改IP白名单

更新时间:

修改AnalyticDB PostgreSQL版实例的IP白名单。

接口说明

为保障 AnalyticDB PostgreSQL 版数据库的安全稳定,系统默认禁止所有外部 IP 地址访问 AnalyticDB PostgreSQL 版实例。在开始使用 AnalyticDB PostgreSQL 版实例前,您需要将客户端的 IP 地址或 IP 地址段添加到 AnalyticDB PostgreSQL 版实例的白名单中。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:ModifySecurityIpsWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ResourceGroupIdstring

该参数已废弃,无需传入该参数。

null
ModifyModestring

IP 白名单修改模式,取值如下:

  • 0(默认):在目标 IP 白名单分组中覆盖原有 IP 地址。
  • 1:在目标 IP 白名单分组中添加 IP 地址。
  • 2:在目标 IP 白名单分组中删除 IP 地址。
0
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 版实例的 ID。
gp-bp12ga6v69h86****
SecurityIPListstring

IP 白名单分组下的 IP 列表,最多 1000 个,以逗号隔开,格式如下:

  • 10.23.12.24(IP)
  • 10.23.12.24/24(CIDR 模式,无类域间路由,/24表示地址中前缀的长度,范围为[1,32]
10.10.**.**
DBInstanceIPArrayNamestring

IP 白名单分组的名称,如果不传默认操作 default 分组。

说明 1 个实例最多支持 50 个白名单分组。
default
DBInstanceIPArrayAttributestring

默认为空。用于区分不同的属性值,控制台不显示带有hidden属性的分组。

hidden

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

871C698F-B43D-4D1D-ACD6-DF56B0F89978

示例

正常返回示例

JSON格式

{
  "RequestId": "871C698F-B43D-4D1D-ACD6-DF56B0F89978"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-05-18OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ModifyMode
  • 本页导读 (1)
文档反馈