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 Getting Details of Network Partitions via REST API
Skip to end of metadata
Go to start of metadata

Overview

DescriptionRetrieve details of all the network partitions.
Resource Path/networkPartitions
HTTP MethodGET
Request/Response Formatapplication/json
> GET /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
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Mar 2015 16:57:34 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
[{"id":"network-partition-2","partitions":[{"id":"partition-1","property":[{"name":"region","value":"ku-cluster-1"}],"public":false}]},{"id":"network-partition-1","partitions":[{"id":"partition-1","property":[{"name":"region","value":"default"}],"public":false}]}]
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/networkPartitions

  • 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 GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/networkPartitions
 
CLI command

list-network-partitions

DescriptionRetrieve details of all the network partitions.
Command format

list-network-partitions


REST API response

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Sample response

[
  {
    "id": "network-partition-2",
    "partitions": [
      {
        "id": "partition-1",
        "property": [
          {
            "name": "region",
            "value": "ku-cluster-1"
          }
        ],
        "public": false
      }
    ]
  },
  {
    "id": "network-partition-1",
    "partitions": [
      {
        "id": "partition-1",
        "property": [
          {
            "name": "region",
            "value": "default"
          }
        ],
        "public": false
      }
    ]
  }
]

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

  • No labels