创建SNS SNMP平台

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

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

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

参数列表

名字	类型	位置	描述	起始版本
snmpAddress	String	body(包含在params结构中)	SNMP服务器地址	4.10.0
snmpPort	Integer	body(包含在params结构中)	SNMP服务器端口	4.10.0
name	String	body(包含在params结构中)	资源名称	4.10.0
description (可选)	String	body(包含在params结构中)	资源的详细描述	4.10.0
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID	4.10.0
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表	4.10.0
systemTags (可选)	List	body	系统标签	4.10.0
userTags (可选)	List	body	用户标签	4.10.0

API返回

返回示例

{
  "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"
  }
}

名字	类型	描述	起始版本
success	boolean		4.10.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.10.0
inventory	SNSApplicationPlatformInventory	详情参考inventory	4.10.0

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	4.10.0
description	String	错误的概要描述	4.10.0
details	String	错误的详细信息	4.10.0
elaboration	String	保留字段，默认为null	4.10.0
opaque	LinkedHashMap	保留字段，默认为null	4.10.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	4.10.0

inventory

名字	类型	描述	起始版本
name	String	资源名称	4.10.0
uuid	String	资源的UUID，唯一标示该资源	4.10.0
description	String	资源的详细描述	4.10.0
type	String	类型	4.10.0
createDate	Timestamp	创建时间	4.10.0
lastOpDate	Timestamp	最后一次修改时间	4.10.0

SDK示例

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