<< Click to Display Table of Contents >> 1.14 获取用户、组、角色节点信息 |
请求地址 |
http://ip:port/bi/api?action=getNode&token=xxxx |
|
请求消息 |
请求参数 |
请求参数:xmlData(必填) <?xml version="1.0" encoding="UTF-8"?> <ref> <type>user</type> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>group</type> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>role</type> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>user</type> <path>test1/hunk1</path> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>group</type> <path>aaa/test1</path> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>role</type> <path>admin_role</path> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>user</type> <name>test1</name> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>group</type> <name>bbb</name> </ref> 或者 <?xml version="1.0" encoding="UTF-8"?> <ref> <type>role</type> <name>admin_role</name> </ref> |
参数描述 |
节点参数信息: 1)type(必填):节点类型,包括三种:用户、组和角色。 2)path(选填):节点完整路径 3)name(选填):节点名称 4)name和path只能存在一个,当name和path同时存在时, 以name为准。 5)如果name和path都不存在或者为空,则返回该类型所有的对象。 |
|
示例 |
function getNode() { var xml = getXml(); $.post("http://" + ip + ":" + port + "/" + project + "/api?action=getNode&token=xxxx", {xmlData : xml}, function(result) { writeXml(result); }); } |
|
响应消息 |
响应结果 |
1) 获取用户响应: <?xml version="1.0" encoding="UTF-8"?> <results> <result> <asset> <user isOverWrite="true"> <name>hunk1</name> <alias></alias> <email>test@qq.com</email> <parent>test1</parent> <roles></roles> </user> </asset> </result> <result> <asset> <user isOverWrite="true"> <name>管理员</name> <alias></alias> <email></email> <parent>test1</parent> <roles>admin_role</roles> </user> </asset> </result> </results> 或者 <?xml version="1.0" encoding="UTF-8"?> <results> <result> <asset> <user> <name>admin</name> <email></email> <alias></alias> <parent></parent> <roles>admin_role</roles> </user> </asset> </result> </results> 2) 获取组响应: <?xml version="1.0" encoding="UTF-8"?> <results> <result> <asset> <group> <name>test1</name> <parent>aaa</parent> <roles>admin_role</roles> </group> </asset> </result> </results> 3) 获取角色响应: <?xml version="1.0" encoding="UTF-8"?> <results> <result> <asset> <role> <name>admin_role</name> <parent></parent> </role> </asset> </result> </results> 4) 操作失败 <?xml version="1.0" encoding="UTF-8"?> <results> <result> <level>6</level> <message>角色“role1”不存在。</message> </result> </results> |
结果描述 |
响应结果信息为xml,直接parse即可。 1)asset 为返回的节点信息。 2)user,group,role:分别对应用户,组,角色信息。 3)level 返回类型,不同数值代表不同返回状态,见附录。 4)message为接口操作结果信息。 |