跳转到主要内容
API Explorer|API Explorer
基础设施相关接口/Agent 插件
POSTAgent起始版本 1.0同步需要认证

注册插件

注册新插件全局插件注册表。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • nameString必填

    资源名称。

    示例： nginx-log-collector

  • versionString必填

    版本号。

    示例： 2.1.0

  • pluginTypeString必填

    分类日志指标Trace。

    示例： log

  • artifactUrlString必填

    制品地址。

    示例： https://artifacts.example.com/plugins/nginx-log-collector-2.1.0.tar.gz

  • checksumString必填

    校验值。

    示例： sha256:abc123def456

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • idString

    资源ID。

    示例： plugin-001-abc

  • nameString

    资源名称。

    示例： nginx-log-collector

  • versionString

    版本号。

    示例： 2.1.0

  • pluginTypeString

    分类日志指标Trace。

    示例： log

  • artifactUrlString

    制品地址。

    示例： https://artifacts.example.com/plugins/nginx-log-collector-2.1.0.tar.gz

  • checksumString

    校验值。

    示例： sha256:abc123def456

  • configSchemaString

    JSON模式字符串插件配置。

    示例： {}

  • pluginRuntimeString

    插件运行时。

    示例： go

  • registeredAtString

    注册时间。

    示例： 2026-01-15T08:00:00Z

请求地址

POST/api/v1/plugins

/api/v1/plugins

操作 ID

RegisterPlugin

永久链接

请求示例

curl -X POST '{host}/api/v1/plugins' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"nginx-log-collector","version":"2.1.0","pluginType":"log","artifactUrl":"https://artifacts.example.com/plugins/nginx-log-collector-2.1.0.tar.gz","checksum":"sha256:abc123def456","configSchema":"{}","pluginRuntime":"go"}'

响应示例

200
{
  "id": "plugin-001-abc",
  "name": "nginx-log-collector",
  "version": "2.1.0",
  "pluginType": "log",
  "artifactUrl": "https://artifacts.example.com/plugins/nginx-log-collector-2.1.0.tar.gz",
  "checksum": "sha256:abc123def456",
  "configSchema": "{}",
  "pluginRuntime": "go"
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史