更新时间:2025-09-11 GMT+08:00
分享

查询客户端接入认证配置

功能介绍

查询实例的客户端接入认证配置。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/hba-info

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID。实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值

不涉及。

offset

Integer

参数解释:

分页符。从第一条数据偏移offset页数据后开始查询。例如,该参数指定为1,limit指定为10,则只展示第11-20条数据。

约束限制:

不涉及。

取值范围:

[0, 2^31-1]

默认取值

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

每页显示的条目数量。

约束限制:

不涉及。

取值范围:

[1, 100]

默认取值

10

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

语言。

约束限制:

不涉及。

取值范围:

  • zh-cn
  • en-us

默认取值

en-us

响应参数

表3 参数说明

参数

参数类型

描述

hba_confs

Array of objects

参数解释:

列表中每个元素表示一条客户端接入配置,详情请参见表3 roles字段数据结构说明

total_count

Integer

参数解释:

总记录数。

取值范围:

[0, 2^31-1],取决于实际查询大小。

表4 hba_confs字段数据结构说明

参数

参数类型

描述

type

String

参数解释:

客户端连接类型。

取值范围:

  • host:表示这条记录既接受一个普通的TCP/IP套接字连接,也接受一个经过SSL加密的TCP/IP套接字连接。
  • hostssl:表示这条记录只接受一个经过SSL加密的TCP/IP套接字连接。
  • hostnossl:表示这条记录只接受一个普通的TCP/IP套接字连接。

database

String

参数解释:

声明记录所匹配且允许访问的数据库,多租特性场景下该参数声明记录所匹配且允许访问的PDB。

取值范围:

  • all:表示该记录匹配所有数据库。
  • 特定的数据库名称或者用逗号分隔的数据库列表。
    说明:
    • 值replication表示如果请求一个复制连接,则匹配,但复制连接不表示任何特定的数据库。如需使用名为replication的数据库,需在database列使用记录“replication”作为数据库名。
    • 多租数据库下,值replication_pdb1表示如果请求一个名为pdb1数据库的复制连接,则匹配成功。值replication方式只生效Non-PDB。
    • PDB复制连接生效配置方式为replication_[pdbname],pdbname为用户创建PDB数据库时候的名字。
    • 如需使用名为replication_pdb1的数据库,需在database列使用记录“replication_pdb1”作为数据库名。

user

String

参数解释:

声明记录所匹配且允许访问的数据库用户。

取值范围:

  • all:表明该记录匹配所有用户。
  • 特定的数据库用户名或者用逗号分隔的用户列表。

address

String

参数解释:

指定与记录匹配且允许访问的IP地址范围。

取值范围:

支持IPv4和IPv6,可以使用如下形式来表示:

IP地址/掩码长度。例如,10.10.0.0/24、2001:250:250:250:250:250:250:175/128

method

String

参数解释:

声明连接时使用的认证方法。

取值范围:

用户API支持如下几种认证方式:

  • reject:无条件地拒绝连接。常用于过滤某些主机。
  • md5:MD5加密算法安全性低,存在安全风险,不推荐使用,建议使用更安全的加密算法。默认不支持,可通过password_encryption_type参数配置。
  • sha256:要求客户端提供一个sha256算法加密的口令进行认证,该口令在传送过程中结合salt(服务器发送给客户端的随机数)的单向sha256加密,增强了安全性。
  • sm3:要求客户端提供一个sm3算法加密口令进行认证,该口令在传送过程中结合salt(服务器发送给客户端的随机数)的单向sm3加密,增加了安全性。
  • cert:客户端证书认证模式,此模式需进行SSL连接配置且需要客户端提供有效的SSL证书,不需要提供用户密码。cert认证方式只支持hostssl类型的规则。

请求示例

查询数据库角色列表。

GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances/{instance_id}/hba-info

响应示例

查询客户端客户端接入认证配置成功。

{
    "hba_confs": [
        {
            "type": "host",
            "database": "all",
            "user": "all",
            "address": "0.0.0.0/0",
            "method": "sha256"
        }
    ],
    "total_count": 1
}

状态码

错误码

请参见错误码

相关文档