IP黑白名单相关接口

增加IP访问控制规则

POST/zstack/v1/login-control/access-control/rules

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "rule1",
    "description": "this is a rule",
    "rule": "172.20.1.1,172.20.1.2",
    "controlStrategy": "ACCEPT"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"rule1","description":"this is a rule","rule":"172.20.1.1,172.20.1.2","controlStrategy":"ACCEPT"}}' http://localhost:8080/zstack/v1/login-control/access-control/rules

参数列表

名字类型位置描述可选值起始版本
nameStringbody(包含在params结构中)资源名称 3.5.1
description (可选)Stringbody(包含在params结构中)资源的详细描述 3.5.1
ruleStringbody(包含在params结构中)  3.5.1
controlStrategyStringbody(包含在params结构中)  3.5.1
resourceUuid (可选)Stringbody(包含在params结构中)  3.5.1
tagUuids (可选)Listbody(包含在params结构中)标签UUID列表 3.5.1
systemTags (可选)Listbody  3.5.1
userTags (可选)Listbody  3.5.1

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

AddAccessControlRuleAction action = new AddAccessControlRuleAction();
action.name = "rule1";
action.description = "this is a rule";
action.rule = "172.20.1.1,172.20.1.2";
action.controlStrategy = "ACCEPT";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddAccessControlRuleAction.Result res = action.call();

Python SDK

AddAccessControlRuleAction action = AddAccessControlRuleAction()
action.name = "rule1"
action.description = "this is a rule"
action.rule = "172.20.1.1,172.20.1.2"
action.controlStrategy = "ACCEPT"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddAccessControlRuleAction.Result res = action.call()

IP黑白名单相关接口

上一页

DELETE删除IP访问控制规则

下一页