All Products
Search
Document Center

ApsaraDB RDS:DescribeModifyPGHbaConfigLog

Last Updated:May 22, 2024

Queries the details about the modifications to the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.

Operation description

Supported database engines

RDS PostgreSQL

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeModifyPGHbaConfigLogRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

A reserved parameter. You do not need to specify this parameter.

1
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

pgm-bp1lymyn1v3i****
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in Coordinated Universal Time (UTC).

2021-11-25T05:00:40Z
EndTimestringNo

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

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

The ID of the resource group.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

DBInstanceIdstring

The instance ID.

pgm-bp1lymyn1v3i****
RequestIdstring

The request ID.

6D797E6B-E157-510C-A27F-6F9E6DA40633
LogItemCountinteger

The number of modification records.

1
HbaLogItemsobject []

An array that consists of the modifications to the pg_hba.conf file.

ModifyStatusstring

The status of the modification.

  • success: The modification is successful.
  • failed: The modification failed.
  • setting: The modification is being applied.
success
StatusReasonstring

The reason why the modification failed.

null
ModifyTimestring

The time when the pg_hba.conf file was modified. The time is displayed in UTC.

2021-11-25T06:00:40Z
BeforeHbaItemsobject []

The configurations of the pg_hba.conf file before modification.

Typestring

The connection type.

host
Maskstring

The mask of the IP address.

null
Databasestring

The name of the database.

all
PriorityIdinteger

The priority.

0
Addressstring

The IP address.

0.0.0.0/0
Optionstring

The value of this parameter varies based on the value of the Method parameter.

null
Methodstring

The authentication method.

md5
Userstring

The username of the account.

all
AfterHbaItemsobject []

The configurations of the pg_hba.conf file after modification.

Typestring

The connection type.

host
Maskstring

The mask of the IP address.

null
Databasestring

The name of the database.

all
PriorityIdinteger

The priority.

0
Addressstring

The IP address.

0.0.0.0/0
Optionstring

The value of this parameter was set based on the value of the Method parameter.

null
Methodstring

The authentication method.

ldap
Userstring

The username of the account.

ldapuser

Examples

Sample success responses

JSONformat

{
  "DBInstanceId": "pgm-bp1lymyn1v3i****",
  "RequestId": "6D797E6B-E157-510C-A27F-6F9E6DA40633",
  "LogItemCount": 1,
  "HbaLogItems": {
    "HbaLogItem": [
      {
        "ModifyStatus": "success",
        "StatusReason": "null",
        "ModifyTime": "2021-11-25T06:00:40Z",
        "BeforeHbaItems": {
          "HbaItem": [
            {
              "Type": "host",
              "Mask": "null",
              "Database": "all",
              "PriorityId": 0,
              "Address": "0.0.0.0/0",
              "Option": "null",
              "Method": "md5",
              "User": "all"
            }
          ]
        },
        "AfterHbaItems": {
          "HbaItem": [
            {
              "Type": "host",
              "Mask": "null",
              "Database": "all",
              "PriorityId": 0,
              "Address": "0.0.0.0/0",
              "Option": "null",
              "Method": "ldap",
              "User": "ldapuser"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.FormatSpecified start time is not valid.The start time is invalid.
400InvalidEndTime.FormatSpecified end time is not valid.The end time is invalid. Check the end time.
400IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
400InvalidDBInstanceName.NotFoundThe 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 timeSummary of changesOperation
2022-08-04The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
2022-02-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change