DescribePGHbaConfig - ApsaraDB RDS - Alibaba Cloud Documentation Center

You can call the DescribePGHbaConfig operation to query the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	This parameter is reserved. You do not need to specify this parameter.	1
DBInstanceId	string	Yes	The ID of the instance. You can call the DescribeDBInstances operation to query the ID of instance.	pgm-bp1lymyn1v3i****
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object
HbaModifyTime	string	The time when the previous modification was made to the pg_hba.conf file.	2021-11-25T06:00:40Z
ModifyStatusReason	string	The reason why the previous modification was made to the pg_hba.conf file.	The specified users (testuser) is not exist.
RequestId	string	The ID of the request.	A147A124-A147-5CCF-9609-B73C028848DF
LastModifyStatus	string	The status of the previous modification to the pg_hba.conf file. Valid values: success: The modification is successful. setting: The modification is being applied. failed: The modification fails.	success
DefaultHbaItems	array	An array that consists of the default configuration items in the pg_hba.conf file.
	object
Type	string	The type of connection to the instance. The value is fixed as host.	host
Mask	string	The mask of the instance. The value is fixed as null.	null
Database	string	The names of the databases that the specified users are allowed to access. The value is fixed as all or replication.	all
PriorityId	integer	The priority of the configuration items in the pg_hba.conf file. This value is automatically generated.	0
Address	string	The IP addresses from which the specified users can access the specified databases. The value is fixed as 0.0.0.0/0.	0.0.0.0/0
Option	string	The value of this parameter is based on the value of the Method parameter. The value is fixed as null.	null
Method	string	The authentication method. The value is fixed as md5.	md5
User	string	The user that is allowed to access the instance. The value is fixed as all.	all
RunningHbaItems	array	An array that consists of the current configuration items in the pg_hba.conf file.
	object
Type	string	The type of the connection. host: The record matches TCP/IP connections, including SSL connections and non-SSL connections. hostssl: The record matches only TCP/IP connections that are established over SSL. hostnossl: The record matches only TCP/IP connections that are not established over SSL.	host
Mask	string	The mask of the instance.	null
Database	string	The name of the database that the specified users are allowed to access.	all
PriorityId	integer	The priority of the instance.	3
Address	string	The IP address of the client.	0.0.0.0/0
Option	string	The value of this parameter varies based on the value of the Method parameter. The value is fixed as null.	null
Method	string	The authentication method.	md5
User	string	The username of the account that is used to connect to the instance.	all
DBInstanceId	string	The ID of the instance.	rm-bp1*****

Examples

Sample success responses

JSONformat

{
  "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*****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	The instance name does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-08-04

The error codes of the API operation change.,The input parameters of the API operation change.,The response structure of the API operation changes.

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: ResourceGroupId
Output Parameters	The response structure of the API operation changes.

2022-02-14

The error codes of the API operation change.

Change item	Change content
Error Codes	The error codes of the API operation change.
	Added Error Codes: 400