SNMP相关接口

创建SNMP代理(CreateSnmpAgent)

API请求

URLs

POST zstack/v1/snmp/agent

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "version": "v3",     "userName": "zstack",     "authAlgorithm": "SHA512",     "authPassword": "auth_password",     "privacyAlgorithm": "DES",     "privacyPassword": "priv_password",     "port": 161   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"version":"v3","userName":"zstack","authAlgorithm":"SHA512","authPassword":"auth_password","privacyAlgorithm":"DES","privacyPassword":"priv_password","port":161}}' http://localhost:8080/zstack/v1/snmp/agent

参数列表

名字	类型	位置	描述	可选值	起始版本
version	String	body(包含在params结构中)	SNMP代理使用协议版本	v2c v3	4.7.21
readCommunity (可选)	String	body(包含在params结构中)	读团体字(version为v2c时使用)		4.7.21
userName (可选)	String	body(包含在params结构中)	用户名(version为v3时使用)		4.7.21
authAlgorithm (可选)	String	body(包含在params结构中)	认证算法	MD5 SHA SHA224 SHA256 SHA384 SHA512	4.7.21
authPassword (可选)	String	body(包含在params结构中)	认证密码		4.7.21
privacyAlgorithm (可选)	String	body(包含在params结构中)	隐私算法	DES AES128 AES192 AES256 3DES	4.7.21
privacyPassword (可选)	String	body(包含在params结构中)	隐私密码		4.7.21
port	int	body(包含在params结构中)	端口		4.7.21
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID		4.7.21
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表		4.7.21
systemTags (可选)	List	body	系统标签		4.7.21
userTags (可选)	List	body	用户标签		4.7.21

API返回

返回示例

{   "inventory": {     "uuid": "6dac2a94d44c3216acc13286a50416aa",     "version": "v3",     "userName": "zstack",     "authAlgorithm": "SHA512",     "authPassword": "auth_password",     "privacyAlgorithm": "DES",     "privacyPassword": "priv_password",     "port": 161,     "status": "Enable",     "securityLevel": "authPriv"   } }

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

#error

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

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.7.21
version	String	SNMP代理使用协议版本	4.7.21
readCommunity	String	读团体字(version为v2c时使用)	4.7.21
userName	String	用户名(version为v3时使用)	4.7.21
authAlgorithm	String	认证算法	4.7.21
authPassword	String	认证密码	4.7.21
privacyAlgorithm	String	隐私算法	4.7.21
privacyPassword	String	隐私密码	4.7.21
port	int	端口	4.7.21
status	String	SNMP代理是否启用	4.7.21
securityLevel	String	安全等级	4.7.21
createDate	Timestamp	创建时间	4.7.21
lastOpDate	Timestamp	最后一次修改时间	4.7.21

SDK示例

Java SDK

CreateSnmpAgentAction action = new CreateSnmpAgentAction(); action.version = "v3"; action.userName = "zstack"; action.authAlgorithm = "SHA512"; action.authPassword = "auth_password"; action.privacyAlgorithm = "DES"; action.privacyPassword = "priv_password"; action.port = 161; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateSnmpAgentAction.Result res = action.call();

Python SDK

CreateSnmpAgentAction action = CreateSnmpAgentAction() action.version = "v3" action.userName = "zstack" action.authAlgorithm = "SHA512" action.authPassword = "auth_password" action.privacyAlgorithm = "DES" action.privacyPassword = "priv_password" action.port = 161 action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateSnmpAgentAction.Result res = action.call()

查询SNMP代理(QuerySnmpAgent)

API请求

URLs

GET zstack/v1/snmp/agent GET zstack/v1/snmp/agent/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

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

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

可查询字段

运行CLI命令行工具，输入QueryLdapServer并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{   "inventories": [     {       "uuid": "f0ef8d847b573c6b86565e1d9111723b",       "version": "v3",       "userName": "zstack",       "authAlgorithm": "SHA512",       "authPassword": "auth_password",       "privacyAlgorithm": "DES",       "privacyPassword": "priv_password",       "port": 161,       "status": "Enable",       "securityLevel": "authPriv"     }   ] }

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

#error

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

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.7.21
version	String	SNMP代理使用协议版本	4.7.21
readCommunity	String	读团体字(version为v2c时使用)	4.7.21
userName	String	用户名(version为v3时使用)	4.7.21
authAlgorithm	String	认证算法	4.7.21
authPassword	String	认证密码	4.7.21
privacyAlgorithm	String	隐私算法	4.7.21
privacyPassword	String	隐私密码	4.7.21
port	int	端口	4.7.21
status	String	SNMP代理是否启用	4.7.21
securityLevel	String	安全等级	4.7.21
createDate	Timestamp	创建时间	4.7.21
lastOpDate	Timestamp	最后一次修改时间	4.7.21

SDK示例

Java SDK

QuerySnmpAgentAction action = new QuerySnmpAgentAction(); action.conditions = asList(); action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; QuerySnmpAgentAction.Result res = action.call();

Python SDK

QuerySnmpAgentAction action = QuerySnmpAgentAction() action.conditions = [] action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" QuerySnmpAgentAction.Result res = action.call()

启动SNMP代理(StartSnmpAgent)

API请求

URLs

PUT zstack/v1/snmp/agent/actions

Headers

Authorization: OAuth the-session-uuid

Body

{   "startSnmpAgent": {     "uuid": "2e5ce17390a843da991411d27b67d775"   },   "systemTags": [],   "userTags": [] }

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"startSnmpAgent":{"uuid":"955799e296a94e4aa2ce063a5b1ea4b8"}}' http://localhost:8080/zstack/v1/snmp/agent/actions

名字	类型	位置	描述	起始版本
uuid	String	body(包含在startSnmpAgent结构中)	资源的UUID，唯一标示该资源	4.7.21
systemTags (可选)	List	body	系统标签	4.7.21
userTags (可选)	List	body	用户标签	4.7.21

API返回

返回示例

{   "inventory": {     "uuid": "eef797ff89d84305b51cc3edcb597909",     "version": "v3",     "userName": "zstack",     "authAlgorithm": "SHA",     "authPassword": "authPassword",     "privacyAlgorithm": "AES128",     "privacyPassword": "privPassword",     "port": 162   } }

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

#error

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

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.7.21
version	String	SNMP代理使用协议版本	4.7.21
readCommunity	String	读团体字(version为v2c时使用)	4.7.21
userName	String	用户名(version为v3时使用)	4.7.21
authAlgorithm	String	认证算法	4.7.21
authPassword	String	认证密码	4.7.21
privacyAlgorithm	String	隐私算法	4.7.21
privacyPassword	String	隐私密码	4.7.21
port	int	端口	4.7.21
status	String	SNMP代理是否启用	4.7.21
securityLevel	String	安全等级	4.7.21
createDate	Timestamp	创建时间	4.7.21
lastOpDate	Timestamp	最后一次修改时间	4.7.21

SDK示例

Java SDK

StartSnmpAgentAction action = new StartSnmpAgentAction(); action.uuid = "a74555a81a4244bb9ce0f8f2b5691ac5"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; StartSnmpAgentAction.Result res = action.call();

Python SDK

StartSnmpAgentAction action = StartSnmpAgentAction() action.uuid = "56f7b7cc6f764c55bf4016cc2257f456" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" StartSnmpAgentAction.Result res = action.call()

下一章:设置相关接口