ModifyPGHbaConfig - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

ApsaraDB RDS for PostgreSQL インスタンスの pg_hba.conf ファイルを変更します。

操作説明

サポートされるデータベースエンジン

RDS PostgreSQL

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:ModifyPGHbaConfig

update

*DBInstance

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

rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	予約済みパラメーターです。このパラメーターを指定する必要はありません。	1
DBInstanceId	string	必須	インスタンス ID。`DescribeDBInstances` 操作を呼び出して、インスタンス ID をクエリできます。	pgm-bp1lymyn1v3i****
OpsType	string	必須	pg_hba.conf ファイルを変更するメソッド。有効な値： add：1 つ以上のレコードを追加します。このメソッドを使用する場合、各新しいレコードの `PriorityId` パラメーターの値が、既存のレコードの `PriorityId` パラメーターの値と異なることを確認してください。 delete：1 つ以上のレコードを削除します。このメソッドを使用する場合、PriorityId パラメーターの指定された値に対応するレコードが `pg_hba.conf` ファイルから削除されます。 modify：1 つ以上のレコードを変更します。このメソッドを使用する場合、`PriorityId` パラメーターの指定された値に対応するレコードが変更されます。 update：新しい構成を使用して、pg_hba.conf ファイル内の既存の構成を上書きします。	add
HbaItem	array<object>	必須	AD ドメインサービスの詳細で構成される配列。
	object	必須
Address	string	必須	指定されたユーザーが指定されたデータベースにアクセスできる IP アドレス。このパラメーターを `0.0.0.0/0` に設定すると、指定されたユーザーはすべての IP アドレスから指定されたデータベースにアクセスできます。	0.0.0.0/0
Database	string	必須	データベースの名前。このパラメーターを `all` に設定すると、指定されたユーザーはインスタンス上のすべてのデータベースにアクセスできます。複数のエントリを指定する場合は、エントリをコンマ (,) で区切ります。	all
Mask	string	任意	IP アドレスのマスク。Address パラメーターの値が IP アドレスの場合、このパラメーターを使用して IP アドレスのマスクを指定できます。	0
Method	string	必須	認証方式。有効な値： trust reject scram-sha-256 md5 password gss sspi ldap radius cert pam	ldap
Option	string	任意	認証方式のオプション。このトピックでは、LDAP を例として使用します。このパラメーターを設定する必要があります。詳細については、「認証方式」をご参照ください。	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	必須	レコードの優先度。このパラメーターを 0 に設定すると、レコードの優先度が最も高くなります。有効な値：0～10000。このパラメーターは、各レコードを識別するために使用されます。レコードを追加する場合、新しいレコードの `PriorityId` パラメーターの値は、既存のレコードの `PriorityId` パラメーターの値と異なる必要があります。レコードを変更または削除する場合、このレコードの `PriorityId` パラメーターの値も変更または削除する必要があります。	2
Type	string	必須	接続タイプ。有効な値： host：レコードは、SSL 接続および非 SSL 接続を含む TCP/IP 接続に一致します。 hostssl：レコードは、SSL 経由で確立された TCP/IP 接続にのみ一致します。 hostnossl：レコードは、SSL 接続経由で確立されていない TCP/IP 接続にのみ一致します。説明このパラメーターは、インスタンスで SSL 暗号化が有効になっている場合にのみ `hostssl` に設定できます。詳細については、「」をご参照ください。	host
User	string	必須	指定されたデータベースへのアクセスを許可されているユーザー。RDS インスタンスへのログインに使用するユーザーを指定する必要があります。複数のエントリを指定する場合は、エントリをコンマ (,) で区切ります。	ldapuser

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエストの ID。	458E0781-C46C-55F5-A0E5-1DD284B28A3F

例

成功レスポンス

JSONJSON

{
  "RequestId": "458E0781-C46C-55F5-A0E5-1DD284B28A3F"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	HbaItem.InvalidType	Specified hba item type is invalid.
400	HbaItem.InvalidMethod	Specified hba item auth method is invalid.
400	HbaItem.InvalidIPMask	Specified hba item ip mask is invalid.
400	HbaItem.InvalidPriority	Specified hba item priorityId is out of range or duplicate.
400	HbaItemOpsType.Invalid	Specified hba opsType is invalid.
400	InvalidConfigValue	The ConfigValue is not valid
400	MinorVersionNotSupport	The current database minor version does not support the operation.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.
400	IncorrectDBInstanceType	Current DB instance type does not support this operation.
400	InvalidIP.Format	The specified IP address is illegal or invalid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not 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.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
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.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it 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.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	HbaItemPriorityIdAlreadyExist	Specified hba item priorityId is exist.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	HbaItemPriorityIdNotFound	Specified hba item priorityId is not found.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。

ApsaraDB RDS:ModifyPGHbaConfig