CreateSNSSnmpPlatform

API Request

URLs

POST zstack/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": []
}

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 POST -d '{"params":{"snmpAddress":"127.0.0.1","snmpPort":161,"name":"snmp platform"}}' \
http://localhost:8080/zstack/v1/sns/application-platforms/snmp

Request Parameters

Name	Type	Location	Description	Starting Version
snmpAddress	String	body (contained in the params structure)	The SNMP server address.	5.0.0
snmpPort	Integer	body (contained in the params structure)	The SNMP port.	5.0.0
name	String	body (contained in the params structure)	The resource name.	5.0.0
description	String	body (contained in the params structure)	Optional. The detailed description of the resource.	5.0.0
resourceUuid	String	body (contained in the params structure)	Optional. The resource uuid.	5.0.0
tagUuids	List	body (contained in the params structure)	Optional. The tag uuid list.	5.0.0
systemTags	List	body	Optional. The system tags.	5.0.0
userTags	List	body	Optional. The user tags.	5.0.0

API Response

Sample Response

{
  "inventory": {
    "uuid": "660744a0d0cd4fe4ad1c11181955f30f",
    "name": "email platform",
    "description": "example description",
    "state": "Enabled",
    "type": "Email",
    "createDate": "Dec 25, 2023 2:07:14 PM",
    "lastOpDate": "Dec 25, 2023 2:07:14 PM"
  }
}

Name	Type	Description	Starting Version
success	boolean		5.0.0
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	5.0.0
inventory	SNSApplicationPlatformInventory	See inventory.	5.0.0

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	5.0.0
description	String	The brief description of the error.	5.0.0
details	String	The details about the error.	5.0.0
elaboration	String	The reserved field. Default value: null.	5.0.0
opaque	LinkedHashMap	The reserved field. Default value: null.	5.0.0
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	5.0.0

#inventory

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	5.0.0
name	String	The resource name.	5.0.0
description	String	The detailed description of the resource.	5.0.0
type	String	The type.	5.0.0
createDate	Timestamp	The creation date.	5.0.0
lastOpDate	Timestamp	The last operation date.	5.0.0

SDK Sample

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()

PreviousCreateSNSSnmpEndpoint NextSNSSnmpTestConnection