Retrieve Database Details via DescribeDatabase API - AnalyticDB for PostgreSQL

Describes the basic information about an AnalyticDB for PostgreSQL database.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:DescribeDatabase	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The cluster ID. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxxxxxxxx
DatabaseName	string	Yes	The name of the database that you want to query.	test01

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
RequestId	string	The unique ID of the request.	ABB39CC3-4488-4857-905D-2E4A051D0521
DBInstanceId	string	The cluster ID.	gp-xxxxxxxxx
DatabaseName	string	The database name. Only contain letters, digits, and underscores (_). Must start with a letter. Up to 63 characters in length.	test01
Description	string	The database comment.	A user management database storing customer profiles.
CharacterSetName	string	The character set. For more information about the value range, see Document https://www.postgresql.org/docs/current/multibyte.html.	UTF8
Collate	string	Database locale parameter that specifies string comparison and sorting rules. Note The locale must be compatible with the character set specified by the CharacterSetName parameter. Collate: You can query available collations using the command SELECT DISTINCT collname FROM pg_collation;. If not specified, the default value is en_US.utf8.	en_US.utf8
Ctype	string	Database locale parameter that specifies character classification and case conversion rules. Note The locale must be compatible with the character set specified by the CharacterSetName parameter. You can execute the SELECT DISTINCT collctype FROM pg_collation; statement to obtain the field value. The default value is en_US.utf8.	en_US.utf8
ConnLimit	string	Limits the number of concurrent connections. -1 indicates unlimited.	-1
TableSpace	string	The database tablespace.	pg_default
Size	string	The database size.	2000 MB
AccessPrivilege	string	The permission control information.	=Tc/test_001\ntest_001=CTc/test_001
Owner	string	The owner of the table. Contain lowercase letters, digits, and underscores (_). Must start with a lowercase letter and end with a lowercase letter or a digit. Cannot start with gp. Must be 2 to 16 characters in length.	testadb

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "DBInstanceId": "gp-xxxxxxxxx",
  "DatabaseName": "test01",
  "Description": "A user management database storing customer profiles.",
  "CharacterSetName": "UTF8",
  "Collate": "en_US.utf8",
  "Ctype": "en_US.utf8",
  "ConnLimit": -1,
  "TableSpace": "pg_default",
  "Size": "2000 MB",
  "AccessPrivilege": "=Tc/test_001\\ntest_001=CTc/test_001",
  "Owner": "testadb"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-11-05	Add Operation	View Change Details