备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS 开发参考 API参考 API目录 账号 ModifyPGHbaConfig - 修改RDS PostgreSQL实例pg_hba.conf文件配置

ModifyPGHbaConfig - 修改RDS PostgreSQL实例pg_hba.conf文件配置

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

该接口用于修改RDS PostgreSQL实例的pg_hba.conf文件配置。

接口说明

适用引擎

RDS PostgreSQL

相关功能文档

注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。

调试

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

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:ModifyPGHbaConfigWrite
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
无

请求参数

名称类型必填描述示例值
ClientTokenstring否

预留参数，无需配置。

1
DBInstanceIdstring是

实例 ID。可调用 DescribeDBInstances 获取。

pgm-bp1lymyn1v3i****
OpsTypestring是

配置类型，支持以下几种方式修改 AD 域服务信息。

  • add：添加一条或多条记录，不能与已有 PriorityId 参数重复。
  • delete：删除一条或多条记录，将删除当前配置中 PriorityId 参数取值对应的记录。
  • modify：修改一条或多条记录，将修改当前配置中 PriorityId 参数取值对应的记录。
  • update：全量更新，将使用传入的配置覆盖当前配置。
add
HbaItemobject []是

AD 域服务信息列表。

Typestring是

连接类型。

支持配置以下取值：

  • host：该条记录验证 TCP/IP 连接，包括 SSL 连接和非 SSL 连接。
  • hostssl：该条记录只验证通过 SSL 建立的 TCP/IP 连接。
  • hostnossl：该条记录只验证通过非 SSL 建立的 TCP/IP 连接。
说明 如果使用 hostssl 连接类型，需要打开 SSL 链路加密，具体请参见 SSL 链路加密。
host
Maskstring否

掩码。如果 Address 为 IP 地址，可以通过此参数指定 IP 地址的掩码。

0
Databasestring是

数据库名。表示允许用户访问的数据库，all 表示允许用户访问所有数据库。

如果配置多个，可通过逗号（,）分隔。

all
PriorityIdinteger是

表示该条记录的优先级，取值范围：0~10000，0 优先级最高。

此参数用于标识每条记录，新增记录时，不允许与已有记录重复。修改或删除时，需要与已有记录的 PriorityId 相同，用于匹配记录。

2
Addressstring是

允许用户从哪个或哪些 IP 访问数据库，0.0.0.0/0 表示允许用户从任意 IP 地址访问数据库。

0.0.0.0/0
Userstring是

允许哪些用户访问数据库，填写实例的用户名。如果配置多个，可通过逗号（,）分隔。

ldapuser
Methodstring是

认证方法。支持：

  • trust
  • reject
  • scram-sha-256
  • md5
  • password
  • gss
  • sspi
  • ldap
  • radius
  • cert
  • pam
ldap
Optionstring否

认证方式对应的可选参数。本示例使用 LDAP 认证，需要配置。此参数的更多参数解释，请参见Authentication Methods。

ldapserver=192.168.XX.XX ldapbasedn="CN=Users,DC=pgsqldomain,DC=net" ldapbinddn="CN=pgadminuser,CN=Users,DC=pgsqldomain,DC=net" ldapbindpasswd="Test123!" ldapsearchattribute="sAMAccountName"

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

458E0781-C46C-55F5-A0E5-1DD284B28A3F

示例

正常返回示例

JSON格式

{
  "RequestId": "458E0781-C46C-55F5-A0E5-1DD284B28A3F"
}

错误码

HTTP status code错误码错误信息描述
400HbaItem.InvalidTypeSpecified hba item type is invalid.-
400HbaItem.InvalidMethodSpecified hba item auth method is invalid.指定的hba项身份验证方法无效。
400HbaItem.InvalidIPMaskSpecified hba item ip mask is invalid.-
400HbaItem.InvalidPrioritySpecified hba item priorityId is out of range or duplicate.-
400HbaItemOpsType.InvalidSpecified hba opsType is invalid.-
400InvalidConfigValueThe ConfigValue is not valid-
400MinorVersionNotSupportThe current database minor version does not support the operation.操作失败，当前小版本不支持该操作。
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.数据库实例名称不存在，请检查。
400IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败，该实例状态下不支持此操作。
400InvalidIP.FormatThe specified IP address is illegal or invalid.指定的 IP 地址非法或无效
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法，请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题，请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单，请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善，请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常，详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整，请在操作前填写您的信息。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
403HbaItemPriorityIdAlreadyExistSpecified hba item priorityId is exist.-
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。
404HbaItemPriorityIdNotFoundSpecified hba item priorityId is not found.-
404IncorrectDBInstanceLockModeCurrent DB instance lock mode does not support this operation.操作失败，实例处于锁定状态。

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

变更历史

变更时间变更内容概要操作
2022-02-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
    删除错误码：403
    删除错误码：404
  • 本页导读 （1）
文档反馈