API Reference | 5.4.12 | ZStack Cloud · ZCF

API Request

URLs

GET zstack/v1/sns/application-platforms/snmp
GET zstack/v1/sns/application-platforms/snmp/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/application-platforms/snmp?q=name=snmp

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/sns/application-platforms/snmp/b9a635c9ff7c3544a232cad5b9a4aaf7

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QuerySNSSnmpPlatform, and pressing the Tab key.

API Response

Sample Response

The API returns an empty JSON structure {} upon successful execution, and in case of an error, 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

QuerySNSSnmpPlatformAction action = new QuerySNSSnmpPlatformAction();
action.conditions = asList("name=snmp");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySNSSnmpPlatformAction.Result res = action.call();

Python SDK

QuerySNSSnmpPlatformAction action = QuerySNSSnmpPlatformAction()
action.conditions = ["name=snmp"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QuerySNSSnmpPlatformAction.Result res = action.call()