Get All Event Metadata

GET/zstack/v1/zwatch/events/meta-data

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/zwatch/events/meta-data?name=VMHAProcess

Parameter List

Name	Type	Location	Description	Starting Version
name (Optional)	String	query	The event name.	3.9.0
namespace (Optional)	String	query	The event namespace.	3.9.0
systemTags (Optional)	List	query	System tags.	0.6
userTags (Optional)	List	query	User tags.	0.6

API Response

Response Example

{
  "events": [
    {
      "namespace": "ZStack/VM",
      "name": "org.zstack.zwatch.datatype.EventFamily@631b5229",
      "description": "VMHAProcess",
      "labelNames": [
        "HAProcess",
        "HADetails"
      ]
    }
  ]
}

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation failed. This field is null when the operation succeeds. See error for details.	2.3
events	List	See events for details.	2.3

error

Name	Type	Description	Starting Version
code	String	The error code number. A globally unique identifier for the error, e.g., SYS.1000, HOST.1001.	0.6
description	String	A brief description of the error.	0.6
details	String	The detailed error information.	0.6
elaboration	String	A reserved field. Default is null.	0.6
opaque	LinkedHashMap	A reserved field. Default is null.	0.6
cause	ErrorCode	The root error. The source error that caused the current error. This field is null if there is no root cause.	0.6

events

Name	Type	Description	Starting Version
namespace	String	The namespace.	2.3
name	String	The resource name.	2.3
description	String	The description.	3.9.0
labelNames	List	The label names.	2.3

SDK Examples

Java SDK

GetAllEventMetadataAction action = new GetAllEventMetadataAction();
action.name = "VMHAProcess";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetAllEventMetadataAction.Result res = action.call();

Python SDK

GetAllEventMetadataAction action = GetAllEventMetadataAction()
action.name = "VMHAProcess"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetAllEventMetadataAction.Result res = action.call()