创建Snmp终端

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "snmp endpoint",
    "platformUuid": "c453382b049c3280b69157501914870d"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"snmp endpoint","platformUuid":"c453382b049c3280b69157501914870d"}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/snmp

参数列表

名字类型位置描述可选值起始版本
nameStringbody(包含在params结构中)资源名称 4.10.0
description (可选)Stringbody(包含在params结构中)资源的详细描述 4.10.0
platformUuid (可选)Stringbody(包含在params结构中)  4.10.0
resourceUuid (可选)Stringbody(包含在params结构中)  4.10.0
tagUuids (可选)Listbody(包含在params结构中)标签UUID列表 4.10.0
systemTags (可选)Listbody系统标签 4.10.0
userTags (可选)Listbody用户标签 4.10.0

API返回

返回示例

{
  "inventory": {
    "name": "example",
    "uuid": "917fe66f76b241f0843dfbd6be685fc1",
    "description": "description example",
    "type": "Email",
    "state": "Enabled",
    "platformUuid": "4eb0ceebf95b452585ebeacd647d9f35",
    "createDate": "Dec 25, 2023 2:08:53 PM",
    "lastOpDate": "Dec 25, 2023 2:08:53 PM"
  }
}
名字类型描述起始版本
successboolean 4.10.0
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error4.10.0
inventorySNSApplicationEndpointInventory详情参考inventory4.10.0

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10014.10.0
descriptionString错误的概要描述4.10.0
detailsString错误的详细信息4.10.0
elaborationString保留字段,默认为null4.10.0
opaqueLinkedHashMap保留字段,默认为null4.10.0
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null4.10.0

inventory

名字类型描述起始版本
nameString短信接收端名称4.10.0
uuidString短信接收端的UUID,唯一标示该资源4.10.0
descriptionString短信接收端的详细描述4.10.0
typeString短信接收端类型4.10.0
platformUuidString应用平台UUID4.10.0
createDateTimestamp创建时间4.10.0
lastOpDateTimestamp最后一次修改时间4.10.0

SDK示例

Java SDK

CreateSNSSnmpEndpointAction action = new CreateSNSSnmpEndpointAction();
action.name = "snmp endpoint";
action.platformUuid = "c453382b049c3280b69157501914870d";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateSNSSnmpEndpointAction.Result res = action.call();

Python SDK

CreateSNSSnmpEndpointAction action = CreateSNSSnmpEndpointAction()
action.name = "snmp endpoint"
action.platformUuid = "c453382b049c3280b69157501914870d"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateSNSSnmpEndpointAction.Result res = action.call()