Use DescribeModifyPGHbaConfigLog to query the pg_hba.conf file modification log - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Queries the modification records of the pg_hba.conf file for an ApsaraDB RDS for PostgreSQL instance.

Operation description

Applicable engines

RDS PostgreSQL.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeModifyPGHbaConfigLog

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The reserved parameter. You do not need to configure this parameter.	1
DBInstanceId	string	Yes	The instance ID. You can call DescribeDBInstances to obtain the instance ID.	pgm-bp1lymyn1v3i****
StartTime	string	No	The start time of the query. Format: yyyy-MM-ddTHH:mmZ (UTC).	2021-11-25T05:00:40Z
EndTime	string	No	The end time of the query. Format: yyyy-MM-ddTHH:mmZ (UTC).	2021-11-25T06:00:40Z
ResourceGroupId	string	No	The resource group ID.	rg-acfmy****

Response elements

Element	Type	Description	Example
	object	The details of the response parameters.
DBInstanceId	string	The instance ID.	pgm-bp1lymyn1v3i****
HbaLogItems	object
HbaLogItem	array<object>	The list of modification records.
	array<object>	The details of a modification record.
AfterHbaItems	object
HbaItem	array<object>	The list of configurations in the pg_hba.conf file after the modification.
	object	The configuration details.
Address	string	The IP address.	0.0.0.0/0
Database	string	The database name.	all
Mask	string	The mask.	null
Method	string	The authentication method.	ldap
Option	string	The parameters corresponding to the authentication method.	ldapserver=192.168.XX.XX ldapbasedn="CN=Users,DC=pgsqldomain,DC=net" ldapbinddn="CN=pgadminuser,CN=Users,DC=pgsqldomain,DC=net" ldapbindpasswd="Test123!" ldapsearchattribute="sAMAccountName"
PriorityId	integer	The priority.	0
Type	string	The connection type.	host
User	string	The username.	ldapuser
BeforeHbaItems	object
HbaItem	array<object>	The list of configurations in the pg_hba.conf file before the modification.
	object	The configuration details.
Address	string	The IP address.	0.0.0.0/0
Database	string	The database name.	all
Mask	string	The mask.	null
Method	string	The authentication method.	md5
Option	string	The parameters corresponding to the authentication method.	null
PriorityId	integer	The priority.	0
Type	string	The connection type.	host
User	string	The username.	all
ModifyStatus	string	The modification status. Valid values: success: The modification has taken effect. failed: The modification has not taken effect. setting: The modification is being applied.	success
ModifyTime	string	The modification time (UTC).	2021-11-25T06:00:40Z
StatusReason	string	The reason why the modification has not taken effect.	null
LogItemCount	integer	The number of history records.	1
RequestId	string	The request ID.	6D797E6B-E157-510C-A27F-6F9E6DA40633

Examples

Success response

JSON format

{
  "DBInstanceId": "pgm-bp1lymyn1v3i****",
  "HbaLogItems": {
    "HbaLogItem": [
      {
        "AfterHbaItems": {
          "HbaItem": [
            {
              "Address": "0.0.0.0/0",
              "Database": "all",
              "Mask": "null",
              "Method": "ldap",
              "Option": "ldapserver=192.168.XX.XX ldapbasedn=\"CN=Users,DC=pgsqldomain,DC=net\" ldapbinddn=\"CN=pgadminuser,CN=Users,DC=pgsqldomain,DC=net\" ldapbindpasswd=\"Test123!\" ldapsearchattribute=\"sAMAccountName\"\n",
              "PriorityId": 0,
              "Type": "host",
              "User": "ldapuser"
            }
          ]
        },
        "BeforeHbaItems": {
          "HbaItem": [
            {
              "Address": "0.0.0.0/0",
              "Database": "all",
              "Mask": "null",
              "Method": "md5",
              "Option": "null",
              "PriorityId": 0,
              "Type": "host",
              "User": "all"
            }
          ]
        },
        "ModifyStatus": "success",
        "ModifyTime": "2021-11-25T06:00:40Z",
        "StatusReason": "null"
      }
    ]
  },
  "LogItemCount": 1,
  "RequestId": "6D797E6B-E157-510C-A27F-6F9E6DA40633"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Format	Specified start time is not valid.	The specified start time is invalid.
400	InvalidEndTime.Format	Specified end time is not valid.	The end time you submitted is invalid. Submit the correct information and try again.
400	IncorrectDBInstanceType	Current DB instance type does not support this operation.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	The database instance name does not exist. Check the instance name and try again.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Bundle instances do not support individual operations.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	No pricing plan result was found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not completed real-name verification and are not eligible to make a purchase. Log on to Expenses and Costs to complete real-name verification.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account balance is less than 0. Top up your account before making a purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	The call to the commodity service failed.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will be discontinued. To ensure business continuity and a smooth data migration, you cannot place new purchase orders at this time. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is invalid. Purchase a valid module and try again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	The region has been decommissioned.
400	Price.CommoditySys	Commodity system call exception.	An exception occurred when calling the commodity system.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	The subscription duration you selected is invalid. Select a valid duration and try again.
400	pay.noCreditCard	Account not bound to credit card.	No credit card is bound to your account.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	An unpaid order exists for the service you selected. Pay or cancel the existing order before placing a new one.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	No payment method is specified for your account. Add a payment method and try again.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is incomplete. Complete your basic information before proceeding.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	An exception occurred on your account. Contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current operation is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	A tag that prohibits order placement exists on your account. Contact your distributor to resolve this issue.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The specified DBInstanceId does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support this storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. Replication slots still exist in the instance, so the parameter cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key has expired.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurred when validating the sales expression.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	The SQL command failed to execute or timed out.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance DPI engine version does not support cold data archiving.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current Milvus version does not support cold data archiving.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The endpoint name already exists. Set a different connection string.
400	RequiredParam.NotFound	Required input param is not found.	Required parameters are missing.
400	Parameters.Invalid	Parameter error, please check the parameters.	Invalid parameter. Check the parameters and try again.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Data archiving does not support cross-region backup or backup within seconds. Check the backup policy.
400	InvalideStatus.Format	The instance status does not support this operation.	The current instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	The data retention policy for archive backups after instance release is invalid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	The DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.	No credit card is available.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Instances of the VPC network type do not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	The mirror database for the current database instance already exists.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The instance type is no longer available for purchase.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query the product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released. Verify the instance status before placing an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The specified region is invalid.
500	ExternalFailure	The request processing has failed due to external service failure.	The request failed. Try again later.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The request failed. Try again later or contact support.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed because the RDS API service encountered an error.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	An unpaid order exists for the current instance. Pay the order and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The target storage capacity after scale-down cannot be less than the current storage usage.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD cloud disks do not support this operation. Upgrade to an ESSD cloud disk and try again.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Your account permissions do not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	The specified VSwitchId is in an invalid format or is empty.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	The current minor engine version does not support this operation.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	No inventory zones are available.
403	NotInFlowController	Sorry,no permission.	This feature is unavailable to non-enterprise cloud migration users. You do not have the required permissions.
403	InvalidKmsKey	Kms key is disabled.	The KMS key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The current database instance edition does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The current instance is not authorized to access Key Management Service.
404	Request.NotFound	The requested resource is not available.	The requested resource is unavailable.
404	HostInfo.NotFound	The specified host info is not found.	The specified host information does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.