DescribePGHbaConfig - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri konfigurasi file pg_hba.conf instans ApsaraDB RDS for PostgreSQL.

Deskripsi operasi

Mesin yang berlaku

RDS PostgreSQL.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribePGHbaConfig

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ClientToken	string	No	Parameter yang dicadangkan. Anda tidak perlu mengonfigurasi parameter ini.	1
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil DescribeDBInstances untuk mendapatkan ID instans.	pgm-bp1lymyn1v3i****
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmy****

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
DBInstanceId	string	ID instans.	rm-bp1****
DefaultHbaItems	object
HbaItem	array<object>	Daftar item konfigurasi default dalam file pg_hba.conf.
	object	Detail item konfigurasi.
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
Database	string	The names of the databases that the specified users are allowed to access. The value is fixed as all or replication.	all
Mask	string	The mask of the instance. The value is fixed as null.	null
Method	string	The authentication method. The value is fixed as md5.	md5
Option	string	The value of this parameter is based on the value of the Method parameter. The value is fixed as null.	null
PriorityId	integer	The priority of the configuration items in the pg_hba.conf file. This value is automatically generated.	0
Type	string	The type of connection to the instance. The value is fixed as host.	host
User	string	The user that is allowed to access the instance. The value is fixed as all.	all
HbaModifyTime	string	Waktu terakhir file pg_hba.conf dimodifikasi.	2021-11-25T06:00:40Z
LastModifyStatus	string	Status modifikasi terakhir pada file pg_hba.conf. Nilai valid: success: Berhasil. setting: Sedang berlangsung. failed: Gagal.	success
ModifyStatusReason	string	Alasan yang sesuai dengan status modifikasi terakhir pada file pg_hba.conf.	The specified users (testuser) is not exist.
RequestId	string	ID permintaan.	A147A124-A147-5CCF-9609-B73C028848DF
RunningHbaItems	object
HbaItem	array<object>	Daftar item konfigurasi saat ini dalam file pg_hba.conf.
	object	Detail item konfigurasi.
Address	string	The IP address of the client.	0.0.0.0/0
Database	string	The name of the database.	all
Mask	string	The mask of the IP address.	null
Method	string	The authentication method.	md5
Option	string	The value of this parameter varies based on the value of the Method parameter. The value is fixed as null.	null
PriorityId	integer	The priority.	3
Type	string	The connection type. Valor: 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 connections.	host
User	string	The username of the account.	all

Contoh

Respons sukses

JSONformat

{
  "DBInstanceId": "rm-bp1****",
  "DefaultHbaItems": {
    "HbaItem": [
      {
        "Address": "0.0.0.0/0",
        "Database": "all",
        "Mask": "null",
        "Method": "md5",
        "Option": "null",
        "PriorityId": 0,
        "Type": "host",
        "User": "all"
      }
    ]
  },
  "HbaModifyTime": "2021-11-25T06:00:40Z",
  "LastModifyStatus": "success",
  "ModifyStatusReason": "The specified users (testuser) is not exist.",
  "RequestId": "A147A124-A147-5CCF-9609-B73C028848DF",
  "RunningHbaItems": {
    "HbaItem": [
      {
        "Address": "0.0.0.0/0",
        "Database": "all",
        "Mask": "null",
        "Method": "md5",
        "Option": "null",
        "PriorityId": 3,
        "Type": "host",
        "User": "all"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IncorrectDBInstanceType	Current DB instance type does not support this operation.
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.
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	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	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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.