This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • 4.1.x Updating a Network Partition via REST API
Skip to end of metadata
Go to start of metadata

Overview

Description

Update a specific network partition.

URL/networkPartitions
HTTP MethodPUT
Request/Response Formatapplication/json

Sample request

{  
   "id":"network-partition-1",
   "provider":"ec2",
   "partitions":[  
      {  
         "id":"partition-1",
         "property":[  
            {  
               "name":"region",
               "value":"default"
            }
         ]
      }
   ]
}
{
  "id": "network-partition-1",
  "provider": "mock",
  "partitions": [
    {
      "id": "partition-1",
      "property": [
        {
          "name": "region",
          "value": "default"
        }
      ]
    }
  ]
}
{  
   "id":"network-partition-1",
   "provider":"kubernetes",
   "partitions":[  
      {  
         "id":"partition-1",
         "property":[  
            {  
               "name":"cluster",
               "value":"kubernetes-cluster-1"
            }
         ]
      }
   ]
}

For information on all the properties that can be used in a network partition definition, see the Network Partition Resource Definition.

> PUT /api/networkPartitions HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Content-Length: 210
>
* upload completely sent off: 210 out of 210 bytes
< HTTP/1.1 200 OK
< Date: Wed, 18 Mar 2015 09:14:48 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":"success","message":"Network Partition updated successfully: [network-partition] network-partition-1"}
curl -X PUT -H "Content-Type: application/json" -d "@<JSON_PAYLOAD>" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/networkPartitions
  • The path to the JSON file that defines the network partition needs to be defined as the  <JSON_PAYLOAD> value.

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
 

For example:

curl -X PUT -H "Content-Type: application/json" -d @'network-partitions/mock/network-partition-1.json' -k -v -u admin:admin https://localhost:9443/api/networkPartitions
 
CLI command
update-network-partition
DescriptionUpdate details of a network partition.
Command format
update-network-partition -p <JSON_FILE_PATH>

The path to the JSON file that defines the network partition needs to be defined as the <JSON_FILE_PATH> value.

REST API Response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

  • No labels