更新AD/LDAP服务器(UpdateLdapServer)

API请求

URLs

PUT zstack/v1/ldap/servers/{ldapServerUuid}

Headers

Authorization: OAuth the-session-uuid

Body

{
"updateLdapServer": {
"name": "new name"
  },
"systemTags": [],
"userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth e0360b3fd1d04df0b98005ab41f233ea" \
-X PUT -d '{"updateLdapServer":{"name":"new name"}}' \
http://localhost:8080/zstack/v1/ldap/servers/6c2af8cab16b3310a3d31aa772b093ba

参数列表


名字	类型	位置	描述	可选值	起始版本
ldapServerUuid	String	url	LDAP服务器的UUID		0.6
name (可选)	String	body(包含在updateLdapServer结构中)	资源名称		0.6
description (可选)	String	body(包含在updateLdapServer结构中)	资源的详细描述		0.6
url (可选)	String	body(包含在updateLdapServer结构中)	LDAP服务器的访问地址		0.6
base (可选)	String	body(包含在updateLdapServer结构中)	LDAP服务器的查询BaseDN		0.6
username (可选)	String	body(包含在updateLdapServer结构中)	访问LDAP服务器的用户名		0.6
password (可选)	String	body(包含在updateLdapServer结构中)	密码		0.6
encryption (可选)	String	body(包含在updateLdapServer结构中)	加密方式	None TLS	0.6
systemTags (可选)	List	body	系统标签		0.6
userTags (可选)	List	body	用户标签		0.6

API返回

返回示例

{
"inventory": {
"uuid": "8e1ee5b25564449fbd6054621567b5c1",
"name": "new name",
"description": "miao desc",
"url": "ldap://localhost:1888",
"base": "dc\u003dexample,dc\u003dcom",
"username": "",
"password": "",
"encryption": "None"
  }
}


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

#error


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

#inventory


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
url	String		0.6
base	String	LDAP服务器访问地址	0.6
username	String	用于访问LDAP服务器的用户名	0.6
password	String	密码	0.6
encryption	String	加密方式	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

SDK示例

Java SDK

UpdateLdapServerAction action = new UpdateLdapServerAction();
action.ldapServerUuid = "37fbaf59c5d74dd7b61c2af4e74c28cf";
action.name = "new name";
action.sessionId = "f968929105af41ef8a6a2c602f315c91";
UpdateLdapServerAction.Result res = action.call();

Python SDK

UpdateLdapServerAction action = UpdateLdapServerAction()
action.ldapServerUuid = "57e7fe86092046228999e8599c6c8bd1"
action.name = "new name"
action.sessionId = "f6ca4878b0164e9eab1d6219777c5af2"
UpdateLdapServerAction.Result res = action.call()