管理规则REST API¶
安全性¶
geofirence rest api只能由具有“管理员”角色的用户访问。
输入/输出¶
数据对象传输¶
XML和JSON都支持数据对象的传输。默认值为XML。或者，可以通过将请求中的“content-type”（post）和“accept”（get）HTTP头设置为“application/json”来使用json。
管理规则的XML编码：：
<AdminRule>
<id>..</id>
<priority>..</priority>
<userName>..</userName>
<roleName>..</roleName>
<addressRange>..</addressRange>
<workspace>..</workspace>
<access>..</access>
</AdminRule>
JSON中规则的编码：
{"id":..,"priority":..,"userName":"..","roleName":"..","addressRange":"..","workspace":"..","access":".."}
如果某个规则对某个特定字段具有“any”（“*”），则该字段要么不包含（默认），要么保留为空，要么用一个星号指定（后两个可用于更新，以区分“不更改此字段”）。
access 应该是 ADMIN 或 USER .
addressRange 是CIDR符号中的字符串（块/位：例如。 127.0.0.1/32 ）
用XML编码规则列表：
<AdminRules count="n">
<AdminRule> ... </AdminRule>
<AdminRule> ... </AdminRule>
...
</AdminRules>
计数的结果将不包括实际的<adminrule>标记。
JSON中规则列表的编码：
{"count":n,"adminrules":[{..},{..},..]}
过滤器参数¶
所有过滤器参数都是可选的。
名字 |
类型 |
描述 |
|---|---|---|
第页 |
数 |
用于对规则列表进行分页。指定页的编号。不要传呼。如果有规定， |
条目 |
数 |
用于分页规则列表。指定每页的条目数。不要传呼。如果指定， |
用户名 |
一串 |
用户名的筛选规则（不包括所有其他指定的用户名）。 |
用户任意 |
0或1。 |
指定是否应包括与任何用户名匹配的规则。 |
角色名 |
一串 |
对rolename筛选规则（不包括所有其他指定的rolename）。 |
劳莱尼 |
0或1。 |
指定是否应包括与任何rolename匹配的规则。 |
工作区 |
一串 |
工作区上的筛选规则（不包括所有其他指定的工作区）。 |
工作区 |
0或1。 |
指定是否应包括与任何工作区匹配的规则。 |
请求¶
/geofence/rest/adminrules/¶
查询所有管理员规则或添加新的管理员规则。
方法 |
行动 |
支持的参数 |
响应 |
|---|---|---|---|
GET |
列出与任何添加的筛选器相关的所有管理规则 |
页面、条目、用户名、用户名称、角色名称、角色名称、工作区、工作区 |
200好。XML中的管理规则列表。 |
POST |
添加新的管理员规则 |
没有 |
插入201。创建 |
/geofence/rest/adminrules/count¶
统计（筛选）管理规则。
方法 |
行动 |
支持的参数 |
响应 |
|---|---|---|---|
GET |
对所有添加的筛选器计算所有管理员规则 |
用户名、userany、rolename、roleany、workspace、workspaceany |
200好。XML中的规则列表计数。 |
/geofence/rest/adminrules/id/<id>¶
查询、修改或删除特定的管理规则。
方法 |
行动 |
支持的参数 |
响应 |
|---|---|---|---|
GET |
读取管理员规则信息 |
没有 |
200好。XML中的AdminRule。 |
POST |
修改管理规则，未指定的字段保持不变。 |
没有 |
200好。 |
DELETE |
删除管理员规则 |
没有 |
200好。 |