插件市场管理
1.插件列表
接口功能介绍
无
接口约束
无
URI
GET /cgw/v1/plugins/list
Accept: application/json
路径参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instId | 是 | String | 实例Id | 7a2828074ef6e32e041a2ef124b19e63 | |
enableOnly | 否 | Boolean | 已启用 | false |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Object | 返回数据 | PluginVO | |
message | String | 异常描述 | success |
表 PluginVO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
category | String | 分组名 | TRAFFIC | |
config | String | 配置详情(yaml格式) | rejected_code: 503only_use_default_delay: falseconn: 1key: ‘remote_addr’: ‘key_type: ‘var’allow_degradation: falsedefault_conn_delay: 0.1disable: falseburst: 1 | |
name | String | 插件名 | limit-conn | |
priority | Integer | 优先级 | 1003 | |
status | Integer | 状态,0:未启用,1:已启用 | 1 | |
summary | String | 简介 | 限制并发请求(或并发连接) | |
version | String | 插件版本 | 0.1 |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/plugins/list?instId=String&enableOnly=true
请求头header
{
"regionId": "1234567890"
}
请求体body
响应示例
{
"statusCode": 2000,
"message": "success",
"returnObj": [
{
"name": "limit-conn",
"category": "TRAFFIC",
"status": 1,
"summary": "限制并发请求(或并发连接)",
"version": "0.1",
"priority": 1003,
"config": "rejected_code: 503\nonly_use_default_delay: false\nconn: 1\nkey: \"remote_addr\": \"\nkey_type: \"var\"\nallow_degradation: false\ndefault_conn_delay: 0.1\ndisable: false\nburst: 1\n"
}
]
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。