URLs

POST zstack/v1/policy-routes/rulesets

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "name": "ruleSet",
    "description": "description",
    "vRouterUuid": "85eb5d9f50bc3919b793b3caf9f3e859"
  },
  "systemTags": [],
  "userTags": []
}

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"name":"ruleSet","description":"description","vRouterUuid":"85eb5d9f50bc3919b793b3caf9f3e859"}}' http://localhost:8080/zstack/v1/policy-routes/rulesets

Request Parameters

Sample Response

{
  "inventory": {
    "name": "name",
    "description": "example-des",
    "rules": [
      {
        "uuid": "74cc4fed46f633f2a618b0e06d122377",
        "ruleNumber": 1.0,
        "ruleSetUuid": "00693e31fa3b3e3fba017ed714c02cdf",
        "tableUuid": "b273e0c273c03559872efa272194492c",
        "destIp": "192.168.1.1",
        "sourceIp": "10.0.0.1",
        "destPort": "22",
        "sourcePort": "80",
        "protocol": "tcp",
        "state": "enable"
      }
    ]
  }
}

#error

#inventory

#rules

#protocol

#state

#l3Refs

Java SDK

CreatePolicyRouteRuleSetAction action = new CreatePolicyRouteRuleSetAction();
action.name = "ruleSet";
action.description = "description";
action.vRouterUuid = "85eb5d9f50bc3919b793b3caf9f3e859";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreatePolicyRouteRuleSetAction.Result res = action.call();

Python SDK

CreatePolicyRouteRuleSetAction action = CreatePolicyRouteRuleSetAction()
action.name = "ruleSet"
action.description = "description"
action.vRouterUuid = "85eb5d9f50bc3919b793b3caf9f3e859"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreatePolicyRouteRuleSetAction.Result res = action.call()

URLs

DELETE zstack/v1/policy-routes/ruleSets/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

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

Request Parameters

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

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

Java SDK

DeletePolicyRouteRuleSetAction action = new DeletePolicyRouteRuleSetAction();
action.uuid = "f430004bc0ed315c89eb7909a48d27e7";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeletePolicyRouteRuleSetAction.Result res = action.call();

Python SDK

DeletePolicyRouteRuleSetAction action = DeletePolicyRouteRuleSetAction()
action.uuid = "f430004bc0ed315c89eb7909a48d27e7"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeletePolicyRouteRuleSetAction.Result res = action.call()

URLs

PUT zstack/v1/policy-routes/ruleSets/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updatePolicyRouteRuleSet": {
    "name": "name",
    "description": "desc"
  },
  "systemTags": [],
  "userTags": []
}

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updatePolicyRouteRuleSet":{"name":"name","description":"desc"}}' http://localhost:8080/zstack/v1/policy-routes/ruleSets/e58212f4cd0c3f2f96d27dde19de1383/actions

Request Parameters

Sample Response

{
  "inventory": {
    "name": "name",
    "description": "example-des",
    "rules": []
  }
}

#error

#inventory

#rules

#protocol

#state

Java SDK

UpdatePolicyRouteRuleSetAction action = new UpdatePolicyRouteRuleSetAction();
action.uuid = "e58212f4cd0c3f2f96d27dde19de1383";
action.name = "name";
action.description = "desc";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdatePolicyRouteRuleSetAction.Result res = action.call();

Python SDK

UpdatePolicyRouteRuleSetAction action = UpdatePolicyRouteRuleSetAction()
action.uuid = "e58212f4cd0c3f2f96d27dde19de1383"
action.name = "name"
action.description = "desc"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdatePolicyRouteRuleSetAction.Result res = action.call()

URLs

GET zstack/v1/policy-routes/rulesets

GET zstack/v1/policy-routes/rulesets/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/rulesets

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/rulesets/f3c338fa05d63ceaa90fedcaffebfd66

Sample Response

{
  "inventories": [
    {
      "name": "name",
      "description": "example-des",
      "rules": [
        {
          "uuid": "2e05ab3c36323487baea2414005817ee",
          "ruleNumber": 1.0,
          "ruleSetUuid": "4c86543d473f3127885b3ffc8be5ec88",
          "tableUuid": "d2ad1f7ad9aa354e8da24829bbd31a05",
          "destIp": "192.168.1.1",
          "sourceIp": "10.0.0.1",
          "destPort": "22",
          "sourcePort": "80",
          "protocol": "tcp",
          "state": "enable"
        }
      ]
    }
  ]
}

#error

#inventories

#rules

#protocol

#state

Java SDK

QueryPolicyRouteRuleSetAction action = new QueryPolicyRouteRuleSetAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPolicyRouteRuleSetAction.Result res = action.call();

Python SDK

QueryPolicyRouteRuleSetAction action = QueryPolicyRouteRuleSetAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryPolicyRouteRuleSetAction.Result res = action.call()

URLs

GET zstack/v1/policy-routes/rulesets/l3networdks/refs

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/rulesets/l3networdks/refs

Sample Response

{
  "inventories": [
    {
      "id": 1.0,
      "l3NetworkUuid": "764cba1766563fd683ef1fcf76c7295c",
      "ruleSetUuid": "ddb87b28f0253810b753fc9ae62ebd31"
    }
  ]
}

#error

#inventories

Java SDK

QueryPolicyRouteRuleSetL3RefAction action = new QueryPolicyRouteRuleSetL3RefAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPolicyRouteRuleSetL3RefAction.Result res = action.call();

Python SDK

QueryPolicyRouteRuleSetL3RefAction action = QueryPolicyRouteRuleSetL3RefAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryPolicyRouteRuleSetL3RefAction.Result res = action.call()

URLs

GET zstack/v1/policy-routes/rulesets/vrouters/refs

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/rulesets/vrouters/refs

Sample Response

{
  "inventories": [
    {
      "id": 1.0,
      "vRouterUuid": "8715faa19cb03995a864330766fdc77c",
      "ruleSetUuid": "2e27f9015ad3357996546fd51c2d808e"
    }
  ]
}

#error

#inventories

Java SDK

QueryPolicyRouteRuleSetVRouterRefAction action = new QueryPolicyRouteRuleSetVRouterRefAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPolicyRouteRuleSetVRouterRefAction.Result res = action.call();

Python SDK

QueryPolicyRouteRuleSetVRouterRefAction action = QueryPolicyRouteRuleSetVRouterRefAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryPolicyRouteRuleSetVRouterRefAction.Result res = action.call()

URLs

POST zstack/v1/policy-routes/rules

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "ruleSetUuid": "ec2472bf205931318e02a2bb5356c0ee",
    "tableUuid": "b4c03beba98c3502ac53d784dd9bfe61",
    "ruleNumber": 1001.0,
    "destIp": "192.168.1.0/24",
    "sourceIp": "192.168.2.0/24",
    "destPort": "22",
    "sourcePort": "33",
    "protocol": "tcp"
  },
  "systemTags": [],
  "userTags": []
}

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"ruleSetUuid":"ec2472bf205931318e02a2bb5356c0ee","tableUuid":"b4c03beba98c3502ac53d784dd9bfe61","ruleNumber":1001.0,"destIp":"192.168.1.0/24","sourceIp":"192.168.2.0/24","destPort":"22","sourcePort":"33","protocol":"tcp"}}' http://localhost:8080/zstack/v1/policy-routes/rules

Request Parameters

Sample Response

{
  "inventory": {
    "uuid": "8b14e8fd1bae3b35acb67d19b8c7580e",
    "ruleNumber": 1.0,
    "ruleSetUuid": "7cd6023e32c639169b2316ffec4c79f3",
    "tableUuid": "3d5c0b99cfac3654a451c854cf449091",
    "destIp": "192.168.1.1",
    "sourceIp": "80",
    "destPort": "22",
    "protocol": "tcp",
    "state": "enable"
  }
}

#error

#inventory

#protocol

#state

Java SDK

CreatePolicyRouteRuleAction action = new CreatePolicyRouteRuleAction();
action.ruleSetUuid = "ec2472bf205931318e02a2bb5356c0ee";
action.tableUuid = "b4c03beba98c3502ac53d784dd9bfe61";
action.ruleNumber = 1001.0;
action.destIp = "192.168.1.0/24";
action.sourceIp = "192.168.2.0/24";
action.destPort = "22";
action.sourcePort = "33";
action.protocol = "tcp";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreatePolicyRouteRuleAction.Result res = action.call();

Python SDK

CreatePolicyRouteRuleAction action = CreatePolicyRouteRuleAction()
action.ruleSetUuid = "ec2472bf205931318e02a2bb5356c0ee"
action.tableUuid = "b4c03beba98c3502ac53d784dd9bfe61"
action.ruleNumber = 1001.0
action.destIp = "192.168.1.0/24"
action.sourceIp = "192.168.2.0/24"
action.destPort = "22"
action.sourcePort = "33"
action.protocol = "tcp"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreatePolicyRouteRuleAction.Result res = action.call()

URLs

DELETE zstack/v1/policy-routes/rules/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

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

Request Parameters

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

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

Java SDK

DeletePolicyRouteRuleAction action = new DeletePolicyRouteRuleAction();
action.uuid = "b02689c3b5513b8db2bb5f45a8c7b169";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeletePolicyRouteRuleAction.Result res = action.call();

Python SDK

DeletePolicyRouteRuleAction action = DeletePolicyRouteRuleAction()
action.uuid = "b02689c3b5513b8db2bb5f45a8c7b169"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeletePolicyRouteRuleAction.Result res = action.call()

URLs

POST zstack/v1/policy-routes/tables

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "vRouterUuid": "efe77450940f3dfe9023f2589fdeda25",
    "number": 1.0,
    "description": "description"
  },
  "systemTags": [],
  "userTags": []
}

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"vRouterUuid":"efe77450940f3dfe9023f2589fdeda25","number":1.0,"description":"description"}}' http://localhost:8080/zstack/v1/policy-routes/tables

Request Parameters

Sample Response

{
  "inventory": {
    "uuid": "8bd52616389d3ce7b5d74bc2424d3f8d",
    "tableNumber": 1.0,
    "description": "example-des",
    "routes": [
      {
        "tableUuid": "2a7ba1261cef3cf19b587e493e479286",
        "destinationCidr": "192.168.1.0/24",
        "nextHopIp": "192.168.1.1",
        "distance": 1.0
      }
    ]
  }
}

#error

#inventory

#routes

Java SDK

CreatePolicyRouteTableAction action = new CreatePolicyRouteTableAction();
action.vRouterUuid = "efe77450940f3dfe9023f2589fdeda25";
action.number = 1.0;
action.description = "description";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreatePolicyRouteTableAction.Result res = action.call();

Python SDK

CreatePolicyRouteTableAction action = CreatePolicyRouteTableAction()
action.vRouterUuid = "efe77450940f3dfe9023f2589fdeda25"
action.number = 1.0
action.description = "description"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreatePolicyRouteTableAction.Result res = action.call()

URLs

DELETE zstack/v1/policy-routes/tables/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/policy-routes/tables/4c24bf6b15d3338ab1d66eac97eec58b?deleteMode=Permissive

Request Parameters

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

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

Java SDK

DeletePolicyRouteTableAction action = new DeletePolicyRouteTableAction();
action.uuid = "4c24bf6b15d3338ab1d66eac97eec58b";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeletePolicyRouteTableAction.Result res = action.call();

Python SDK

DeletePolicyRouteTableAction action = DeletePolicyRouteTableAction()
action.uuid = "4c24bf6b15d3338ab1d66eac97eec58b"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeletePolicyRouteTableAction.Result res = action.call()

URLs

GET zstack/v1/policy-routes/tables

GET zstack/v1/policy-routes/tables/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/tables

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/tables/e32b296e6633331284c5cbbd71cedfa4

Sample Response

{
  "inventories": [
    {
      "uuid": "6e39025e9eb432fda488f19e7104fdf0",
      "tableNumber": 1.0,
      "description": "example-des",
      "routes": [
        {
          "tableUuid": "90f075232c383565ac3dbc09554c4152",
          "destinationCidr": "192.168.1.0/24",
          "nextHopIp": "192.168.1.1",
          "distance": 1.0
        }
      ]
    }
  ]
}

#error

#inventories

#routes

Java SDK

QueryPolicyRouteTableAction action = new QueryPolicyRouteTableAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPolicyRouteTableAction.Result res = action.call();

Python SDK

QueryPolicyRouteTableAction action = QueryPolicyRouteTableAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryPolicyRouteTableAction.Result res = action.call()

URLs

GET zstack/v1/policy-routes/tables/vrouters/refs

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/tables/vrouters/refs

Sample Response

{
  "inventories": [
    {
      "id": 1.0,
      "tableUuid": "cc3bb710f9d43cedb044213253363604",
      "vRouterUuid": "f281299552813438acc3c5a400802a78"
    }
  ]
}

#error

Java SDK

QueryPolicyRouteTableVRouterRefAction action = new QueryPolicyRouteTableVRouterRefAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPolicyRouteTableVRouterRefAction.Result res = action.call();

Python SDK

QueryPolicyRouteTableVRouterRefAction action = QueryPolicyRouteTableVRouterRefAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryPolicyRouteTableVRouterRefAction.Result res = action.call()

URLs

POST zstack/v1/policy-routes/routes

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "tableUuid": "ef44a453884a3b93867d6ec0b7dd5716",
    "destinationCidr": "192.168.1.0/24",
    "nextHopIp": "192.168.1.1",
    "distance": 1.0
  },
  "systemTags": [],
  "userTags": []
}

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"tableUuid":"ef44a453884a3b93867d6ec0b7dd5716","destinationCidr":"192.168.1.0/24","nextHopIp":"192.168.1.1","distance":1.0}}' http://localhost:8080/zstack/v1/policy-routes/routes

Request Parameters

Sample Response

{
  "inventory": {
    "tableUuid": "a6e9466373c333948f8d6ef573992d43",
    "destinationCidr": "192.168.1.0/24",
    "nextHopIp": "192.168.1.1",
    "distance": 1.0
  }
}

#error

#inventory

Java SDK

CreatePolicyRouteTableRouteEntryAction action = new CreatePolicyRouteTableRouteEntryAction();
action.tableUuid = "ef44a453884a3b93867d6ec0b7dd5716";
action.destinationCidr = "192.168.1.0/24";
action.nextHopIp = "192.168.1.1";
action.distance = 1.0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreatePolicyRouteTableRouteEntryAction.Result res = action.call();

Python SDK

CreatePolicyRouteTableRouteEntryAction action = CreatePolicyRouteTableRouteEntryAction()
action.tableUuid = "ef44a453884a3b93867d6ec0b7dd5716"
action.destinationCidr = "192.168.1.0/24"
action.nextHopIp = "192.168.1.1"
action.distance = 1.0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreatePolicyRouteTableRouteEntryAction.Result res = action.call()

URLs

DELETE zstack/v1/policy-routes/routes/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

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

Request Parameters

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

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

Java SDK

DeletePolicyRouteTableRouteEntryAction action = new DeletePolicyRouteTableRouteEntryAction();
action.uuid = "7e28a7059fb33a8bb2d7c61b7951303e";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeletePolicyRouteTableRouteEntryAction.Result res = action.call();

Python SDK

DeletePolicyRouteTableRouteEntryAction action = DeletePolicyRouteTableRouteEntryAction()
action.uuid = "7e28a7059fb33a8bb2d7c61b7951303e"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeletePolicyRouteTableRouteEntryAction.Result res = action.call()

URLs

GET zstack/v1/policy-routes/routes

GET zstack/v1/policy-routes/routes/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/routes

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/routes/775c98615c5936f3aab19b6271c9e5dc

Sample Response

{
  "inventories": [
    {
      "tableUuid": "49bf5678360b38058ab7096715e219f4",
      "destinationCidr": "192.168.1.0/24",
      "nextHopIp": "192.168.1.1",
      "distance": 1.0
    }
  ]
}

#error

#inventories

Java SDK

QueryPolicyRouteTableRouteEntryAction action = new QueryPolicyRouteTableRouteEntryAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPolicyRouteTableRouteEntryAction.Result res = action.call();

Python SDK

QueryPolicyRouteTableRouteEntryAction action = QueryPolicyRouteTableRouteEntryAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryPolicyRouteTableRouteEntryAction.Result res = action.call()

URLs

GET zstack/v1/policy-routes/rules

GET zstack/v1/policy-routes/rules/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/rules

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/rules/cc3c19210de13878994ddcb5bee8a34c

Sample Response

{
  "inventories": [
    {
      "uuid": "538840755c1a36e0b79f1d04097b252e",
      "ruleNumber": 1.0,
      "ruleSetUuid": "7cb413c84b243290a7105e8c21f42b59",
      "tableUuid": "d29940b692f33c0eaf96b0193029636c",
      "destIp": "192.168.1.1",
      "sourceIp": "80",
      "destPort": "22",
      "protocol": "tcp",
      "state": "enable"
    }
  ]
}

#error

#inventories

#protocol

#state

Java SDK

QueryPolicyRouteRuleAction action = new QueryPolicyRouteRuleAction();
action.conditions = asList();
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryPolicyRouteRuleAction.Result res = action.call();

Python SDK

QueryPolicyRouteRuleAction action = QueryPolicyRouteRuleAction()
action.conditions = []
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryPolicyRouteRuleAction.Result res = action.call()

URLs

POST zstack/v1/policy-routes/rulesets/{ruleSetUuid}/l3networks/{l3Uuid}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {},
  "systemTags": [],
  "userTags": []
}

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{}}' http://localhost:8080/zstack/v1/policy-routes/rulesets/1e6eb259093e3fa2a30c837ae69d259c/l3networks/8748b8be922938bbb430ed9cbe3e4e46

Request Parameters

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

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

Java SDK

AttachPolicyRouteRuleSetToL3Action action = new AttachPolicyRouteRuleSetToL3Action();
action.l3Uuid = "8748b8be922938bbb430ed9cbe3e4e46";
action.ruleSetUuid = "1e6eb259093e3fa2a30c837ae69d259c";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachPolicyRouteRuleSetToL3Action.Result res = action.call();

Python SDK

AttachPolicyRouteRuleSetToL3Action action = AttachPolicyRouteRuleSetToL3Action()
action.l3Uuid = "8748b8be922938bbb430ed9cbe3e4e46"
action.ruleSetUuid = "1e6eb259093e3fa2a30c837ae69d259c"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AttachPolicyRouteRuleSetToL3Action.Result res = action.call()

URLs

DELETE zstack/v1/policy-routes/rulesets/{ruleSetUuid}/l3networks/{l3Uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/policy-routes/rulesets/75641a6f70c03fcea051d7fb5e45a0e5/l3networks/9556f3da05743aa88a603e086875e22c

Request Parameters

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

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

Java SDK

DetachPolicyRouteRuleSetFromL3Action action = new DetachPolicyRouteRuleSetFromL3Action();
action.l3Uuid = "9556f3da05743aa88a603e086875e22c";
action.ruleSetUuid = "75641a6f70c03fcea051d7fb5e45a0e5";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DetachPolicyRouteRuleSetFromL3Action.Result res = action.call();

Python SDK

DetachPolicyRouteRuleSetFromL3Action action = DetachPolicyRouteRuleSetFromL3Action()
action.l3Uuid = "9556f3da05743aa88a603e086875e22c"
action.ruleSetUuid = "75641a6f70c03fcea051d7fb5e45a0e5"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DetachPolicyRouteRuleSetFromL3Action.Result res = action.call()

URLs

GET zstack/v1/policy-routes/rulesets/virtualrouter/{vmInstanceUuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/policy-routes/rulesets/virtualrouter/d38e9c3321af3f01a5509fa7f43dc46a

Request Parameters

Sample Response

{
  "inventories": [
    {
      "uuid": "de191bb7f4763ce580fd7e2ed457cde8",
      "name": "policy-rule-set",
      "description": "policy rule set",
      "type": "User",
      "rules": [],
      "l3Refs": []
    }
  ]
}

#error

#inventories

#rules

#protocol

#state

#l3Refs

Java SDK

GetPolicyRouteRuleSetFromVirtualRouterAction action = new GetPolicyRouteRuleSetFromVirtualRouterAction();
action.vmInstanceUuid = "d38e9c3321af3f01a5509fa7f43dc46a";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetPolicyRouteRuleSetFromVirtualRouterAction.Result res = action.call();

Python SDK

GetPolicyRouteRuleSetFromVirtualRouterAction action = GetPolicyRouteRuleSetFromVirtualRouterAction()
action.vmInstanceUuid = "d38e9c3321af3f01a5509fa7f43dc46a"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetPolicyRouteRuleSetFromVirtualRouterAction.Result res = action.call()