系统设置相关接口

ZStack ZSphere 4.10.0>ZStack Cloud ZStack ZSphere产品文档>ZStack ZSphere 开发手册>系统管理>系统设置相关接口

日志服务器相关接口

添加日志服务器配置(AddLogConfiguration)

API请求

URLs

POST zstack/v1/log/configurations

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "syslog",     "type": "log4j2",     "configuration": "{\n\"appenderType\": \"Syslog\",\n\"configuration\": {\n\"hostname\": \"192.168.0.11\",\n\"port\": \"514\",\n\"protocol\": \"UDP\",\n\"facility\": \"LOCAL5\"\n}\n}"   },   "systemTags": [],   "userTags": [] }

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"syslog","type":"log4j2","configuration":"{\n\"appenderType\": \"Syslog\",\n\"configuration\": {\n\"hostname\": \"192.168.0.11\",\n\"port\": \"514\",\n\"protocol\": \"UDP\",\n\"facility\": \"LOCAL5\"\n}\n}"}}' http://localhost:8080/zstack/v1/log/configurations

参数列表

名字	类型	位置	描述	起始版本
name	String	body(包含在params结构中)	资源名称	3.10.0
description (可选)	String	body(包含在params结构中)	资源的详细描述	3.10.0
type	String	body(包含在params结构中)		3.10.0
configuration	String	body(包含在params结构中)		3.10.0
resourceUuid (可选)	String	body(包含在params结构中)	资源UUID	3.10.0
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表	3.10.0
systemTags (可选)	List	body	系统标签	3.10.0
userTags (可选)	List	body	用户标签	3.10.0

API返回

返回示例

{   "inventory": {     "id": 0.0,     "labelKey": "log4j2-f2828a4c39af4605a86a94a36b8f7865",     "labelValue": "{\n\"appenderType\": \"Syslog\",\n\"configuration\": {\n\"hostname\": \"192.168.0.11\",\n\"port\": \"514\",\n\"protocol\": \"UDP\",\n\"facility\": \"LOCAL5\"\n}\n}"   } }

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

#error

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

#inventory

名字	类型	描述	起始版本
id	long		3.10.0
labelKey	String		3.10.0
labelValue	String		3.10.0
resourceUuid	String	资源UUID	3.10.0
createDate	Timestamp	创建时间	3.10.0
lastOpDate	Timestamp	最后一次修改时间	3.10.0

SDK示例

Java SDK

AddLogConfigurationAction action = new AddLogConfigurationAction(); action.name = "syslog"; action.type = "log4j2"; action.configuration = "{ "appenderType": "Syslog", "configuration": { "hostname": "192.168.0.11", "port": "514", "protocol": "UDP", "facility": "LOCAL5" } }"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; AddLogConfigurationAction.Result res = action.call();

Python SDK

AddLogConfigurationAction action = AddLogConfigurationAction() action.name = "syslog" action.type = "log4j2" action.configuration = "{ "appenderType": "Syslog", "configuration": { "hostname": "192.168.0.11", "port": "514", "protocol": "UDP", "facility": "LOCAL5" } }" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" AddLogConfigurationAction.Result res = action.call()

删除日志服务器配置(DeleteLogConfiguration)

API请求

URLs

DELETE zstack/v1/log/configurations/log4j2

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/log/configurations/log4j2?deleteMode=Permissive

参数列表

名字	类型	位置	描述	可选值	起始版本
configId	Long	body	配置id		3.10.0
deleteMode (可选)	String	body	删除模式，默认为Permissive	Enforcing Permissive	3.10.0
systemTags (可选)	List	body	系统标签		3.10.0
userTags (可选)	List	body	用户标签		3.10.0

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{ "error": {     "code": "SYS.1001",     "description": "A message or a operation timeout",     "details": "Create VM on KVM timeout after 300s" } }

SDK示例

Java SDK

DeleteLogConfigurationAction action = new DeleteLogConfigurationAction(); action.configId = 0.0; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteLogConfigurationAction.Result res = action.call();

Python SDK

DeleteLogConfigurationAction action = DeleteLogConfigurationAction() action.configId = 0.0 action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DeleteLogConfigurationAction.Result res = action.call()