DescribePostgresExtensions - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries extensions that are installed on a database.

Operation description

Supported database engines

RDS PostgreSQL

References

Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Manage extensions

Debugging

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

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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:DescribePostgresExtensions		acs:rds:{#regionId}:{#accountId}:*	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.	ETnLKlblzczshOTUbOCz****
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	pgm-bp156o9ti493****
DBName	string	Yes	The database name. You can call the DescribeDatabases operation to query the database name.	test_db
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmy****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC
UninstalledExtensions	object []	The list of extensions that are not installed on the specified database.
Name	string	The name of the extension.	pg_cron
DefaultVersion	string	The default version of the extension.	4.1
InstalledVersion	string	The current version of the extension.	4.1
Comment	string	The purpose of the extension.	PostgreSQL load profile repository and report builder
Owner	string	The user of the extension.	test_user
Priority	string	The priority of the extension.	0
Requires	string	The extensions on which the current extension depends when it is installed.	{dblink,plpgsql}
Category	string	The category of the extension.	information_stat
InstalledExtensions	object []	The list of extensions that are installed on the specified database.
Name	string	The name of the extension.	pg_profile
DefaultVersion	string	The default version of the extension.	4.1
InstalledVersion	string	The current version of the extension.	4.1
Comment	string	The purpose of the extension.	PostgreSQL load profile repository and report builder
Owner	string	The user of the extension.	test_user
Priority	string	The priority of the extension. 0: The extension is displayed by default. 1: The extension is preferentially displayed.	0
Requires	string	The extensions on which the current extension depends when it is installed.	{dblink,plpgsql}
Category	string	The category of the extension. external_access index_support information_stat geography_space vector_engine timing_engine data_type encrypt_secure text_process operation_maintenance self_develop	information_stat
Overview	object	The overview of the extension.	None

Examples

Sample success responses

JSONformat

{
  "RequestId": "7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC",
  "UninstalledExtensions": [
    {
      "Name": "pg_cron",
      "DefaultVersion": "4.1",
      "InstalledVersion": "4.1",
      "Comment": "PostgreSQL load profile repository and report builder",
      "Owner": "test_user",
      "Priority": "0",
      "Requires": "{dblink,plpgsql}",
      "Category": "information_stat"
    }
  ],
  "InstalledExtensions": [
    {
      "Name": "pg_profile",
      "DefaultVersion": "4.1",
      "InstalledVersion": "4.1",
      "Comment": "PostgreSQL load profile repository and report builder",
      "Owner": "test_user",
      "Priority": "0",
      "Requires": "{dblink,plpgsql}",
      "Category": "information_stat"
    }
  ],
  "Overview": {
    "test": "test",
    "test2": 1
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDBInstanceName.NotFound	The specified DB instance name does not exist.	The instance name does not exist.
400	InvalidDBName.Format	Specified DB name is not valid.	The database name is invalid. Specify a valid name. The name can be up to 16 characters in length and can contain lowercase letters, digits, and underscores (_). The name must start with a lowercase letter and end with a lowercase letter or a digit.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	The RDS instance cannot be found, is deleted, or does not support the operation.

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

Change history

Change time	Summary of changes	Operation

No change history