查询插件

功能介绍

获取指定数据库的插件信息。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

接口约束

• 该接口公测中，如需使用请联系客服申请。
• 实例在创建、变更规格、修改端口、冻结、异常等状态下不能执行该操作。

URI

• URI格式

  GET /v3/{project_id}/instances/{instance_id}/extensions?database_name={database_name}&offset={offset}&limit={limit}

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。
  database_name	是	数据库名称。
  offset	否	索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。
  limit	否	查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求消息

• 请求参数

  无。

• URI样例

  GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/extensions?database_name=db1

响应消息

• 正常响应要素说明

  表2 要素说明

  名称	参数类型	说明
  extensions	Array of objects	插件列表信息。 详情请参见表3。
  total_count	Integer	总插件数。

  表3 extensions元素结构说明

  名称	参数类型	说明
  name	String	插件名称。
  database_name	String	数据库名称。
  version	String	插件版本。
  version_update	String	可更新的插件版本。如果和version字段值不一致，说明插件可更新。
  shared_preload_libraries	String	依赖预加载库。
  created	Boolean	插件是否已创建。
  description	String	插件描述。

• 正常响应样例

  { 
     "extensions" : [ { 
       "name" : "pg_cron", 
       "database_name" : "db1", 
       "version" : "1.0", 
       "version_update" : "1.0", 
       "shared_preload_libraries" : "pg_cron", 
       "created" : false, 
       "description" : "pg_cron access method - signature file based index" 
     }, { 
       "name" : "dblink", 
       "database_name" : "db1", 
       "version" : "1.2", 
       "version_update" : "1.2", 
       "shared_preload_libraries" : "", 
       "created" : false, 
       "description" : "connect to other PostgreSQL databases from within a database" 
     } ], 
     "total_count" : 2 
   }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。