文档

DescribePostgresExtensions - 获取实例目标数据库下所有插件的信息

更新时间:

该接口用于获取实例目标数据库下所有插件的信息。

接口说明

适用引擎

RDS PostgreSQL

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

管理插件

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribePostgresExtensionsRead
  • acs:rds:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符,且该参数值中不能包含非 ASCII 字符。

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

pgm-bp156o9ti493****
DBNamestring

数据库名。可调用 DescribeDatabases 获取。

test_db
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

7E4448A6-9FE6-4474-A0C1-AA7CFC772CAC
UninstalledExtensionsobject []

指定数据库下未安装插件信息列表。

Namestring

插件名称。

pg_cron
DefaultVersionstring

插件默认版本。

4.1
InstalledVersionstring

插件当前安装的版本。

4.1
Commentstring

插件用途。

PostgreSQL load profile repository and report builder
Ownerstring

插件所属用户。

test_user
Prioritystring

插件优先级。

0
Requiresstring

此插件安装时所依赖的插件。

{dblink,plpgsql}
Categorystring

插件类别。

information_stat
InstalledExtensionsobject []

指定数据库下已安装插件信息列表。

Namestring

插件名称。

pg_profile
DefaultVersionstring

插件默认版本。

4.1
InstalledVersionstring

插件当前安装的版本。

4.1
Commentstring

插件用途。

PostgreSQL load profile repository and report builder
Ownerstring

插件所属用户。

test_user
Prioritystring

插件优先级。

  • 0:默认展示。
  • 1:优先展示。
0
Requiresstring

此插件安装时所依赖的插件。

{dblink,plpgsql}
Categorystring

插件类别。

  • external_access:外部访问。
  • index_support:索引支持。
  • information_stat:信息统计。
  • geography_space:地理时空。
  • vector_engine:向量引擎。
  • timing_engine:时序引擎。
  • data_type:数据类型。
  • encrypt_secure:加密和安全。
  • text_process:文本处理。
  • operation_maintenance:应用运维。
  • self_develop:自研。
information_stat
Overviewobject

插件概览相关信息。

None

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidDBInstanceName.NotFoundThe specified DB instance name does not exist.数据库实例名称不存在,请检查。
400InvalidDBName.FormatSpecified DB name is not valid.无效的数据库名称。请重新命名,数据库名称由小写字母,数字、下划线组成,字母开头,字母或数字结尾,最长16个字符。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈