API Reference | 5.5.38 | ZStack Cloud · ZCF

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	Starting Version
name	String	body (contained in the refreshPluginDrivers structure)	Optional. The resource name.	5.3.0
systemTags	List	body	Optional. The system tags.	5.3.0
userTags	List	body	Optional. The user tags.	5.3.0

API Response

When this API succeeds, an empty JSON structure is returned{}. When an error occurs, the returned JSON structure contains 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

action = RefreshPluginDriversAction()
action.name = "prometheus"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()