Region
prev Chapter 3 /sdn/v2.0 next

Region

Regions

List regions

Sample request 

List all regions:

GET /sdn/v2.0/regions

There is no request body for this API.

Sample response 

 {
   "regions":[
      {
         "uid":"adc5e492-957c-4f8c-aa0a-97fa2dac5f01",
         "master":{
            "ip":"125.200.104.101",
            "name":"Controller_1"
         },
         "slaves":[
            {
               "ip":"125.200.104.102",
               "name":"Controller_2"
            }
         ],
         "devices":[
            {
               "ip":"125.200.104.200"
            }
         ]
      }
   ]
}

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

Create region

Sample request 

Create a region:

POST /sdn/v2.0/regions
{
   "region":{
      "master":{
         "ip":"125.200.104.101",
         "name":"Controller_1"
      },
      "slaves":[
         {
            "ip":"125.200.104.102",
            "name":"Controller_2"
         }
      ],
      "devices":[
         {
            "ip":"125.200.104.200"
         }
      ]
   }
}

Sample response 

{
   "region":{
      "uid":"adc5e492-957c-4f8c-aa0a-97fa2dac5f01",
      "master":{
         "ip":"125.200.104.101",
         "name":"Controller_1"
      },
      "slaves":[
         {
            "ip":"125.200.104.102",
            "name":"Controller_2"
         }
      ],
      "devices":[
         {
            "ip":"125.200.104.200"
         }
      ]
   }
}

Location header: http://<controller>/sdn/v2.0/region/{region_uid}

Response codes 

  • Normal: OK (201)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

Regions{region uid}

List regions

Sample request 

List the region with the give region_uid:

GET /sdn/v2.0/regions/{region_uid}

There is no request body for this API.

Sample response 

{
   "region":{
      "uid":"adc5e492-957c-4f8c-aa0a-97fa2dac5f01",
      "master":{
         "ip":"125.200.104.101",
         "name":"Controller_1"
      },
      "slaves":[
         {
            "ip":"125.200.104.102",
            "name":"Controller_2"
         }
      ],
      "devices":[
         {
            "ip":"125.200.104.200"
         }
      ]
   }
}

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

Update region

Sample request 

Update a region with the give region uid:

PUT /sdn/v2.0/regions/{region_uid}
{
   "region":{
      "master":{
         "ip":"125.200.104.101",
         "name":"Controller_1"
      },
      "slaves":[
         {
            "ip":"125.200.104.102",
            "name":"Controller_2"
         }
      ],
      "devices":[
         {
            "ip":"125.200.104.200"
         }
      ]
   }
}

Sample response 

{
   "region":{
      "uid":"adc5e492-957c-4f8c-aa0a-97fa2dac5f01",
      "master":{
         "ip":"125.200.104.101",
         "name":"Controller_1"
      },
      "slaves":[
         {
            "ip":"125.200.104.102",
            "name":"Controller_2"
         }
      ],
      "devices":[
         {
            "ip":"125.200.104.200"
         }
      ]
   }
}

Location header: http://<controller>/sdn/v2.0/region/{region_uid}

Response codes 

  • Normal: OK (200)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

Delete region

Sample request 

Delete a region with region_uid:

DELETE /sdn/v2.0/regions/{region_uid}

There is no request body for this API.

Sample response 

There is no response data for this API.

Response codes 

  • Normal: No Content (204)

  • Error: Unauthorized (401), Not Found (404), Service Unavailable (503)

prev up next
Systems home Team