Create SNS SNMP Platform

POST/zstack/v1/sns/application-platforms/snmp

Request

cURL

curl --request POST \
  --url '/v1/sns/application-platforms/snmp' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/sns/application-platforms/snmp"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "snmpAddress": "127.0.0.1",
    "snmpPort": 161,
    "name": "snmp platform"
  },
  "systemTags": [],
  "userTags": []
}

The systemTags and userTags fields in the above example are optional. They are listed to indicate that the body can contain these two fields.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"snmpAddress":"127.0.0.1","snmpPort":161,"name":"snmp platform"}}' http://localhost:8080/zstack/v1/sns/application-platforms/snmp

Parameter List

Name	Type	Location	Description	Starting Version
snmpAddress	String	body (contained in the params structure)	SNMP server address	4.10.0
snmpPort	Integer	body (contained in the params structure)	SNMP server port	4.10.0
name	String	body (contained in the params structure)	Resource name	4.10.0
description (optional)	String	body (contained in the params structure)	Detailed description of the resource	4.10.0
resourceUuid (optional)	String	body (contained in the params structure)	Resource UUID	4.10.0
tagUuids (optional)	List	body (contained in the params structure)	Tag UUID list	4.10.0
systemTags (optional)	List	body	System tags	4.10.0
userTags (optional)	List	body	User tags	4.10.0

API Response

Response Example

{
  "inventory": {
    "uuid": "e13b9854866747738df3026dabae9689",
    "name": "email platform",
    "description": "example description",
    "state": "Enabled",
    "type": "Email",
    "createDate": "Sep 28, 2023 4:34:04 PM",
    "lastOpDate": "Sep 28, 2023 4:34:04 PM"
  }
}

Name	Type	Description	Starting Version
success	boolean		4.10.0
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. See error	4.10.0
inventory	SNSApplicationPlatformInventory	See inventory	4.10.0

error

Name	Type	Description	Starting Version
code	String	Error code number. A globally unique identifier for the error, e.g., SYS.1000, HOST.1001	4.10.0
description	String	Brief description of the error	4.10.0
details	String	Detailed error information	4.10.0
elaboration	String	Reserved field. Defaults to null	4.10.0
opaque	LinkedHashMap	Reserved field. Defaults to null	4.10.0
cause	ErrorCode	Root error. The source error that caused this error. Null if no root cause exists	4.10.0

inventory

Name	Type	Description	Starting Version
name	String	Resource name	4.10.0
uuid	String	Resource UUID. Uniquely identifies the resource	4.10.0
description	String	Detailed description of the resource	4.10.0
type	String	Type	4.10.0
createDate	Timestamp	Creation time	4.10.0
lastOpDate	Timestamp	Last modification time	4.10.0

SDK Examples

Java SDK

CreateSNSSnmpPlatformAction action = new CreateSNSSnmpPlatformAction();
action.snmpAddress = "127.0.0.1";
action.snmpPort = 161;
action.name = "snmp platform";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateSNSSnmpPlatformAction.Result res = action.call();

Python SDK

CreateSNSSnmpPlatformAction action = CreateSNSSnmpPlatformAction()
action.snmpAddress = "127.0.0.1"
action.snmpPort = 161
action.name = "snmp platform"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateSNSSnmpPlatformAction.Result res = action.call()