Volcano API
🚀 API Endpoints

🔌 Plugin Management

Plugin installation, configuration, and management endpoints. 15 endpoints available.

🎯 Quick Stats

📊 Methods

  • 🔍 GET: 8 endpoints
  • 🗑️ DELETE: 1 endpoints
  • ✏️ PUT: 3 endpoints
  • 📝 POST: 3 endpoints

🔐 Authentication

All endpoints in this section use the same authentication methods. Choose one:

🔑 Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

🔧 API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

⚠️ Important: Do not use both authentication methods simultaneously in the same request.

🔗 Endpoints Overview

MethodEndpointDescription
🔍 GET/plugins获取所有插件信息
🔍 GET/plugins/{pluginId}获取单个插件信息
🗑️ DELETE/plugins/{pluginId}卸载插件
✏️ PUT/plugins/{pluginId}/enable启用插件
✏️ PUT/plugins/{pluginId}/disable禁用插件
✏️ PUT/plugins/{pluginId}/config配置插件
📝 POST/plugins/{pluginId}/execute执行单个插件
📝 POST/plugins/execute-all执行所有启用的订单卡片插件
🔍 GET/plugins/stats/all获取所有插件统计信息
🔍 GET/plugins/{pluginId}/stats获取单个插件统计信息
🔍 GET/plugins/search搜索插件
📝 POST/plugins/rediscover重新发现并加载插件
🔍 GET/plugins/health/all获取所有插件健康状态
🔍 GET/plugins/stats/types获取插件类型统计
🔍 GET/plugins/stats/status获取插件状态统计

📖 Detailed Documentation

获取所有插件信息

GET/plugins
Full URL
https://api.market.decenctype.com/plugins

🔐 Authentication: Required (see authentication section above)

Description: 获取所有插件信息

Operation ID: getAllPlugins

Response Status:

  • 200: 插件信息列表

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

获取单个插件信息

GET/plugins/{pluginId}
Full URL
https://api.market.decenctype.com/plugins/{pluginId}

🎯 Path Parameters

  • pluginId (string) - ✅ Required: 插件ID

Description: 获取单个插件信息

Operation ID: getPlugin

Response Status:

  • 200: 插件详细信息
  • 404: 插件不存在

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

卸载插件

DELETE/plugins/{pluginId}
Full URL
https://api.market.decenctype.com/plugins/{pluginId}

🎯 Path Parameters

  • pluginId (string) - ✅ Required: 插件ID

Description: 卸载插件

Operation ID: unloadPlugin

Response Status:

  • 200: 插件已卸载
  • 400: 卸载失败

📝 Example Request

curl -X DELETE "https://api.market.decenctype.com/plugins/example-id" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

启用插件

PUT/plugins/{pluginId}/enable
Full URL
https://api.market.decenctype.com/plugins/{pluginId}/enable

🎯 Path Parameters

  • pluginId (string) - ✅ Required: 插件ID

Description: 启用插件

Operation ID: enablePlugin

Response Status:

  • 200: 插件已启用
  • 404: 插件不存在

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/plugins/example-id/enable" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

禁用插件

PUT/plugins/{pluginId}/disable
Full URL
https://api.market.decenctype.com/plugins/{pluginId}/disable

🎯 Path Parameters

  • pluginId (string) - ✅ Required: 插件ID

Description: 禁用插件

Operation ID: disablePlugin

Response Status:

  • 200: 插件已禁用
  • 404: 插件不存在

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/plugins/example-id/disable" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

配置插件

PUT/plugins/{pluginId}/config
Full URL
https://api.market.decenctype.com/plugins/{pluginId}/config

🎯 Path Parameters

  • pluginId (string) - ✅ Required: 插件ID

Description: 配置插件

Operation ID: configurePlugin

Response Status:

  • 200: 插件配置已更新
  • 400: 配置无效

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/plugins/example-id/config" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'

执行单个插件

POST/plugins/{pluginId}/execute
Full URL
https://api.market.decenctype.com/plugins/{pluginId}/execute

🎯 Path Parameters

  • pluginId (string) - ✅ Required: 插件ID

Description: 执行单个插件

Operation ID: executePlugin

Response Status:

  • 200: 插件执行完成
  • 201: Success
  • 400: 执行失败

📝 Example Request

curl -X POST "https://api.market.decenctype.com/plugins/example-id/execute" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'

执行所有启用的订单卡片插件

POST/plugins/execute-all
Full URL
https://api.market.decenctype.com/plugins/execute-all

Description: 执行所有启用的订单卡片插件

Operation ID: executeAllPlugins

Response Status:

  • 200: 所有插件执行完成
  • 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/plugins/execute-all" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{}'

获取所有插件统计信息

GET/plugins/stats/all
Full URL
https://api.market.decenctype.com/plugins/stats/all

🔐 Authentication: Required (see authentication section above)

Description: 获取所有插件统计信息

Operation ID: getAllPluginStats

Response Status:

  • 200: 插件统计信息

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins/stats/all" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

获取单个插件统计信息

GET/plugins/{pluginId}/stats
Full URL
https://api.market.decenctype.com/plugins/{pluginId}/stats

🎯 Path Parameters

  • pluginId (string) - ✅ Required: 插件ID

Description: 获取单个插件统计信息

Operation ID: getPluginStats

Response Status:

  • 200: 插件统计信息
  • 404: 插件不存在

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins/example-id/stats" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

搜索插件

GET/plugins/search
Full URL
https://api.market.decenctype.com/plugins/search

📋 Query Parameters

ParameterTypeRequiredDescription
querystring搜索关键词
typestring插件类型

Description: 搜索插件

Operation ID: searchPlugins

Response Status:

  • 200: 搜索结果

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins/search" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

重新发现并加载插件

POST/plugins/rediscover
Full URL
https://api.market.decenctype.com/plugins/rediscover

🔐 Authentication: Required (see authentication section above)

Description: 重新发现并加载插件

Operation ID: rediscoverPlugins

Response Status:

  • 200: 插件重新发现完成
  • 201: Success

📝 Example Request

curl -X POST "https://api.market.decenctype.com/plugins/rediscover" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

获取所有插件健康状态

GET/plugins/health/all
Full URL
https://api.market.decenctype.com/plugins/health/all

🔐 Authentication: Required (see authentication section above)

Description: 获取所有插件健康状态

Operation ID: getPluginHealth

Response Status:

  • 200: 插件健康状态

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins/health/all" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

获取插件类型统计

GET/plugins/stats/types
Full URL
https://api.market.decenctype.com/plugins/stats/types

🔐 Authentication: Required (see authentication section above)

Description: 获取插件类型统计

Operation ID: getPluginTypeStats

Response Status:

  • 200: 插件类型统计

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins/stats/types" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

获取插件状态统计

GET/plugins/stats/status
Full URL
https://api.market.decenctype.com/plugins/stats/status

🔐 Authentication: Required (see authentication section above)

Description: 获取插件状态统计

Operation ID: getPluginStatusStats

Response Status:

  • 200: 插件状态统计

📝 Example Request

curl -X GET "https://api.market.decenctype.com/plugins/stats/status" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"