Document navigation

Plugin Operations

DeletePluginDrivers

API Request

URLs
DELETE zstack/v1/external/plugins/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/external/plugins/e90949fe5ddd3e68a4646b97b812f905
Request Parameters
Name Type Location Description Valid Values Starting Version
uuid String body (contained in the params structure) The resource UUID. 5.3.28
systemTags List body Optional. The system tags. 5.3.28
userTags List body Optional. The user tags. 5.3.28
deleteMode String body Optional. The deletetion mode (Permissive / Enforcing,Permissive). 5.3.28

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,
{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

SDK Sample

Java SDK
DeletePluginDriversAction action = new DeletePluginDriversAction();
action.uuid = "e90949fe5ddd3e68a4646b97b812f905";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeletePluginDriversAction.Result res = action.call();
Python SDK
DeletePluginDriversAction action = DeletePluginDriversAction()
action.uuid = "e90949fe5ddd3e68a4646b97b812f905"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeletePluginDriversAction.Result res = action.call()

RefreshPluginDrivers

API Request

URLs
PUT zstack/v1/external/plugins
Headers
Authorization: OAuth the-session-uuid
Body
{
  "refreshPluginDrivers": {
    "name": "prometheus"
  },
  "systemTags": [],
  "userTags": []
}
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"refreshPluginDrivers":{"name":"prometheus"}}' http://localhost:8080/zstack/v1/external/plugins
Request Parameters
Name Type Location Description Valid Values Description
uuid String body (contained in the params structure) The resource UUID. 5.3.28
systemTags List body Optional. The system tags. 5.3.28
userTags List body Optional. The user tags. 5.3.28

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,
{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

SDK Sample

Java SDK
RefreshPluginDriversAction action = new RefreshPluginDriversAction();
action.name = "prometheus";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RefreshPluginDriversAction.Result res = action.call();
Python SDK
RefreshPluginDriversAction action = RefreshPluginDriversAction()
action.name = "prometheus"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RefreshPluginDriversAction.Result res = action.call()
API Reference | 5.4.12 | ZStack Cloud · ZCF | ZStack Resource Center