该接口用于修改RDS PostgreSQL实例的pg_hba.conf文件配置。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyPGHbaConfig | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 预留参数,无需配置。 | 1 |
DBInstanceId | string | 是 | 实例 ID。可调用 DescribeDBInstances 获取。 | pgm-bp1lymyn1v3i**** |
OpsType | string | 是 | 配置类型,支持以下几种方式修改 AD 域服务信息。
| add |
HbaItem | object [] | 是 | AD 域服务信息列表。 | |
Type | string | 是 | 连接类型。 支持配置以下取值:
说明
如果使用 hostssl 连接类型,需要打开 SSL 链路加密,具体请参见 SSL 链路加密。
| host |
Mask | string | 否 | 掩码。如果 Address 为 IP 地址,可以通过此参数指定 IP 地址的掩码。 | 0 |
Database | string | 是 | 数据库名。表示允许用户访问的数据库,all 表示允许用户访问所有数据库。 如果配置多个,可通过逗号(,)分隔。 | all |
PriorityId | integer | 是 | 表示该条记录的优先级,取值范围:0~10000,0 优先级最高。 此参数用于标识每条记录,新增记录时,不允许与已有记录重复。修改或删除时,需要与已有记录的 PriorityId 相同,用于匹配记录。 | 2 |
Address | string | 是 | 允许用户从哪个或哪些 IP 访问数据库,0.0.0.0/0 表示允许用户从任意 IP 地址访问数据库。 | 0.0.0.0/0 |
User | string | 是 | 允许哪些用户访问数据库,填写实例的用户名。如果配置多个,可通过逗号(,)分隔。 | ldapuser |
Method | string | 是 | 认证方法。支持:
| ldap |
Option | string | 否 | 认证方式对应的可选参数。本示例使用 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" |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "458E0781-C46C-55F5-A0E5-1DD284B28A3F"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | HbaItem.InvalidType | Specified hba item type is invalid. | - |
400 | HbaItem.InvalidMethod | Specified hba item auth method is invalid. | 指定的hba项身份验证方法无效。 |
400 | HbaItem.InvalidIPMask | Specified hba item ip mask is invalid. | - |
400 | HbaItem.InvalidPriority | Specified hba item priorityId is out of range or duplicate. | - |
400 | HbaItemOpsType.Invalid | Specified hba opsType is invalid. | - |
400 | InvalidConfigValue | The ConfigValue is not valid | - |
400 | MinorVersionNotSupport | The current database minor version does not support the operation. | 操作失败,当前小版本不支持该操作。 |
400 | InvalidDBInstanceName.NotFound | The specified DB instance name does not exist. | 数据库实例名称不存在,请检查。 |
400 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
400 | InvalidIP.Format | The specified IP address is illegal or invalid. | 指定的 IP 地址非法或无效 |
400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐实例不允许单独操作。 |
400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定价计划价格结果没有找到。 |
400 | Order.NoRealNameAuthentication | You 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. | 您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。 |
400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的账户可用额度小于0,请先充值后再尝试购买。 |
400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 调用商品服务返回失败。 |
403 | HbaItemPriorityIdAlreadyExist | Specified hba item priorityId is exist. | - |
403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 当前实例状态不支持此操作。 |
404 | HbaItemPriorityIdNotFound | Specified hba item priorityId is not found. | - |
404 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失败,实例处于锁定状态。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-02-14 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|