查询插件列表
查询支持的插件信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instances/{instance_id}/plugins?limit={limit}&offset={offset}&plugin_name={plugin_name}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
limit |
否 |
Integer |
参数解释: 查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。 约束限制: 不涉及。 取值范围: [1, 100] 默认取值: 默认为100。 |
offset |
否 |
Integer |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。例如:该参数指定为1,limit指定为10,则只展示第2-11条数据。 约束限制: 不涉及。 取值范围: [0, 2^31-1] 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
plugin_name |
否 |
String |
参数解释: 插件包名称。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
Integer |
参数解释: 插件数量。 取值范围: 不涉及。 |
plugins |
Array of objects |
参数解释: 插件详细信息。具体请参见表4。 取值范围: 不涉及。 |
请求示例
https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/plugins?limit=10&offset=10
响应示例
{ "plugins": [ { "plugin_name": "postgis", "installed": true, "plugin_version": "1.0.0", "port": "8080" } ], "total_count": 2 }
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。