This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Getting Details of a Network Partition - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
||
Skip to end of metadata
Go to start of metadata

You can retrieve details of a network partition using the CLI tool, the REST API or the PPaaS Console as shown below:

 

Getting details of a network partition via the CLI

Overview
CLI command

describe-network-partition

DescriptionRetrieve details of a specific network partition.
Command format
describe-network-partition <NETWORK_PARTITION_ID>
Parameter definition
Short optionLong optionDescriptionRequiredExample value
N/AN/AThe network partition IDYes

network-partition-1

Example

Retrieving the details of the network partition with the id: network-partition-1.

describe-network-partition network-partition-1
Sample output
{
  "id": "network-partition-1",
  "provider": "mock",
  "partitions": [
    {
      "id": "partition-1",
      "property": [
        {
          "name": "region",
          "value": "default"
        }
      ]
    },
    {
      "id": "partition-2",
      "property": [
        {
          "name": "region",
          "value": "default"
        }
      ]
    }
  ]
}

Getting details of a network partition via the REST API

Overview
DescriptionRetrieve details of a specific network partition.
Resource Path/networkPartitions/{networkPartitionId}
HTTP MethodGET
Request/Response Formatapplication/json
Command format
curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/networkPartitions/{networkPartitionId}
  • By default, <USERNAME>:<PASSWORD> is admin:admin.
  • By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <PRIVATE_PAAS_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.
Example

Retrieving the details of the network partition with the id:  network-partition-1 .

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/networkPartitions/network-partition-1
Sample output
> GET /api/networkPartitions/network-partition-1 HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> 
< HTTP/1.1 200 OK
< Date: Fri, 02 Oct 2015 11:45:13 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"id":"network-partition-1","partitions":[{"id":"partition-1","property":[{"name":"region","value":"default"}]},{"id":"partition-2","property":[{"name":"region","value":"default"}]}],"provider":"mock"}

You will come across the following HTTP status codes while retrieving details of a specific network partition:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Getting details of a network partition via the PPaaS Console

Follow the instructions below to get details of a network partition:

  1. Click Configurations on the home page.
  2. Click Network Partitions.
  3. Hover your mouse pointer over the network partition definition you wish to view details on for the Details button to appear and click Details.
  4. Update the network partition details as required. For property definitions, see the Network Partition Resource Definition.
     
  5. Click SAVE to update the network partition. 

 


 

  • No labels