查询插件 - ListPostgresqlExtension
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
接口约束
- 该接口支持主实例和只读实例查询插件。
- 实例在创建、变更规格、修改端口、冻结、异常等状态下不能执行该操作。
URI
- URI格式
GET /v3/{project_id}/instances/{instance_id}/extensions?database_name={database_name}&offset={offset}&limit={limit}
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
instance_id
是
参数解释：
实例ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
database_name
是
参数解释：
数据库名称。
约束限制：
不涉及。
取值范围：
该参数值可调用查询数据库列表接口，通过表3中的“name”获取。
默认取值：
不涉及。
offset
否
参数解释：
索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。
约束限制：
不涉及。
取值范围：
大于等于0的整数。
默认取值：
默认为0，偏移0条数据，表示从第一条数据开始查询。
limit
否
参数解释：
查询记录数。
约束限制：
不涉及。
取值范围：
[1, 100]
默认取值：
100
请求消息
响应消息
- 正常响应要素说明
表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
参数解释：
插件是否已创建。
取值范围：
- true：插件已创建。
- false：插件未创建。
description
String
参数解释：
插件描述。
取值范围：
不涉及。
- 正常响应样例
{ "extensions" : [ { "name" : "pg_cron", "database_name" : "db1", "version" : "1.6", "version_update" : "1.6", "shared_preload_libraries" : "pg_cron", "created" : false, "description" : "Job scheduler for PostgreSQL" }, { "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 } - 异常响应
请参见异常响应结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
