全部产品
Search
文档中心

云数据库 RDS:DescribePGHbaConfig - 查询RDS PostgreSQL实例pg_hba.conf文件配置

更新时间:May 29, 2023

查询RDS PostgreSQL实例的pg_hba.conf文件的配置。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

预留参数,无需配置。

1
DBInstanceIdstring

实例ID。可以通过接口DescribeDBInstances查看。

pgm-bp1lymyn1v3i****
ResourceGroupIdstring

资源组ID。

rg-acfmy*****

返回参数

名称类型描述示例值
object

返回参数详情如下。

HbaModifyTimestring

pg_hba.conf文件最近一次修改的时间。

2021-11-25T06:00:40Z
ModifyStatusReasonstring

此参数显示pg_hba.conf文件最近一次修改状态对应的原因。

The specified users (testuser) is not exist.
RequestIdstring

请求ID。

A147A124-A147-5CCF-9609-B73C028848DF
LastModifyStatusstring

pg_hba.conf文件最近一次修改的状态。返回值如下:

  • success:成功
  • setting:设置中
  • failed:失败
success
DefaultHbaItemsobject []

pg_hba.conf文件的默认配置项列表。

Typestring

连接类型,固定值:host。

host
Maskstring

掩码,固定为空。

null
Databasestring

数据库名称,固定值:all和replication。

all
PriorityIdinteger

优先级,自动生成。

0
Addressstring

IP地址,固定值:0.0.0.0/0。

0.0.0.0/0
Optionstring

认证方式对应配置参数,固定为空。

null
Methodstring

认证方式,固定值:md5。

md5
Userstring

用户名,固定值:all。

all
RunningHbaItemsobject []

pg_hba.conf文件的当前配置项。

Typestring

连接类型,返回值如下:

  • host:该条记录验证TCP/IP连接,包括SSL连接和非SSL连接。
  • hostssl:该条记录只验证通过SSL建立的TCP/IP连接。
  • hostnossl:该条记录只验证通过非SSL建立的TCP/IP连接。
host
Maskstring

掩码。

null
Databasestring

数据库名。

all
PriorityIdinteger

优先级。

3
Addressstring

客户端IP地址。

0.0.0.0/0
Optionstring

认证方式对应的配置参数。不需要配置时,置为空。

null
Methodstring

认证方式。

md5
Userstring

用户名。

all
DBInstanceIdstring

实例ID。

rm-bp1*****

示例

正常返回示例

JSON格式

{
  "HbaModifyTime": "2021-11-25T06:00:40Z",
  "ModifyStatusReason": "The specified users (testuser) is not exist.",
  "RequestId": "A147A124-A147-5CCF-9609-B73C028848DF",
  "LastModifyStatus": "success",
  "DefaultHbaItems": {
    "HbaItem": [
      {
        "Type": "host",
        "Mask": "null",
        "Database": "all",
        "PriorityId": 0,
        "Address": "0.0.0.0/0",
        "Option": "null",
        "Method": "md5",
        "User": "all"
      }
    ]
  },
  "RunningHbaItems": {
    "HbaItem": [
      {
        "Type": "host",
        "Mask": "null",
        "Database": "all",
        "PriorityId": 3,
        "Address": "0.0.0.0/0",
        "Option": "null",
        "Method": "md5",
        "User": "all"
      }
    ]
  },
  "DBInstanceId": "rm-bp1*****"
}

错误码

HTTP status code错误码错误信息描述
400IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.数据库实例名称不存在,请检查。

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

变更历史

变更时间变更内容概要操作
2022-08-04OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
2022-02-14OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400