Updated on 2024-06-07 GMT+08:00

Querying the pg_hba.conf File Configurations of a DB Instance

Function

This API is used to query the pg_hba.conf file configurations of a DB instance.

  • Before calling an API, you need to understand the API in Authentication.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Instance ID.

Request

  • Request parameters

    None

  • URI example

    GET https://rds.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/e28979107ed04d3b8b2f1b819b8d2be3in03/hba-info

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    Array elements

    Array of objects

    Parameter list.

    For details, see Table 3.

    Table 3 Parameters

    Parameter

    Type

    Description

    type

    String

    Connection type. Enumerated values: host, hostssl, and hostnossl

    database

    String

    Database name other than template0 and template1. Use commas (,) to separate multiple names.

    user

    String

    Name of a user other than rdsAdmin, rdsMetric, rdsBackup, rdsRepl, and rdsProxy.

    • all indicates all database users of the DB instance.
    • Use commas (,) to separate multiple user names.

    address

    String

    Client IP address. 0.0.0.0/0 indicates that the user can access the database from any IP address.

    mask

    String

    Subnet mask. The default value is an empty string.

    method

    String

    Authentication mode. Enumerated values: reject, md5, and scram-sha-256

    priority

    Integer

    Configuration priority.

  • Example normal response
    [ { 
       "type" : "host", 
       "database" : "all", 
       "user" : "all", 
       "address" : "0.0.0.0/0", 
       "mask" : "", 
       "method" : "md5", 
       "priority" : 0 
     } ]

Status Code

Error Code

For details, see Error Codes.