Plugin

A Plugin is a resource managing endpoints of the plugin instances deployed. If there is a plugin instance that does not work properly, the Plugin requests the Supervisor to redeploy the instance.

Package : spaceone.api.plugin.v1

Plugin

Plugin Methods:

get_plugin_endpoint

Gets the endpoint of a specific plugin instance. A Plugin returns only a single endpoint by determining labels and priority. If the requested plugin instance is already deployed, the endpoint is returned. If not, the endpoint is returned after deploying the plugin instance.

{{< tabs " get_plugin_endpoint " >}}

{{< tab "Request Example" >}}

PluginEndpointRequest

  • plugin_id (string) Required

  • domain_id (string) Required

  • version (string)

  • upgrade_mode (UpgradeMode)

  • labels (Struct)

{{< highlight json >}} { "plugin_id": "plugin-aws-sns-mon-webhook", "version": "1.2.2" } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

PluginEndpoint

  • endpoint (string) Required

  • access_token (string) Required

  • updated_version (string)

{{< highlight json >}} { "endpoint": "grpc://endpoint-url:50051" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get_plugin_metadata

POST /plugin/v1/plugin/get-plugin-metadata

notify_failure

Message

PluginEndpoint

  • endpoint (string) Required

  • access_token (string) Required

  • updated_version (string)

PluginEndpointRequest

  • plugin_id (string) Required

  • domain_id (string) Required

  • version (string)

  • upgrade_mode (UpgradeMode)

  • labels (Struct)

PluginFailureRequest

  • supervisor_id (string) Required

  • version (string) Required

  • domain_id (string) Required

  • plugin_id (string) Required

PluginMetadata

  • metadata (Struct) Required

PluginMetadataRequest

  • plugin_id (string) Required

  • version (string)

  • upgrade_mode (UpgradeMode)

  • options (Struct)

Last updated