查询客户端接入认证配置
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instances/{instance_id}/hba-info
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
hba_confs |
Array of objects |
参数解释: 列表中每个元素表示一条客户端接入配置,详情请参见表3 roles字段数据结构说明。 |
total_count |
Integer |
参数解释: 总记录数。 取值范围: [0, 2^31-1],取决于实际查询大小。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
参数解释: 客户端连接类型。 取值范围:
|
database |
String |
参数解释: 声明记录所匹配且允许访问的数据库,多租特性场景下该参数声明记录所匹配且允许访问的PDB。 取值范围:
|
user |
String |
参数解释: 声明记录所匹配且允许访问的数据库用户。 取值范围:
|
address |
String |
参数解释: 指定与记录匹配且允许访问的IP地址范围。 取值范围: 支持IPv4和IPv6,可以使用如下形式来表示: IP地址/掩码长度。例如,10.10.0.0/24、2001:250:250:250:250:250:250:175/128。 |
method |
String |
参数解释: 声明连接时使用的认证方法。 取值范围: 用户API支持如下几种认证方式:
|
请求示例
查询数据库角色列表。
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 }
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。