Overview

DescriptionRetrieve details of all cluster properties in an application.
Resource Path

/applications/{application_id}/clusters/{cluster_id}/properties

HTTP MethodGET
Request/Response Format

application/json

Sample Response

> GET /metadata/api/applications/wordpress/clusters/wordpress.my-php.php.domain/properties HTTP/1.1
> 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
> Authorization: Bearer
> eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjY3NTk1MzEsInN1YiI6ImFkbWluIiwiYXpwIjoib
nlmemVtYzc5cTRTMDA2SFZ1UGRRNFgxQnRzYSIsImFwcElkIjoid29yZHByZXNzIiwiYX
VkIjpbIm55ZnplbWM3OXE0UzAwNkhWdVBkUTRYMUJ0c2EiXSwiaXNzIjoiaHR0cHM6XC9cL2
xvY2FsaG9zdDo5NDQzXC9vYXV0aDJlbmRwb2ludHNcL3Rva2VuIiwiaWF0IjoxNDY2NzYwNTM1
fQ.ThJjslyOStYwF5ldsy3jBmprA9OanEIr9VVOCocUNNrR-osDJ3ObyZbwd-5gwjvj_pzCgvi2TFD
0Z7wpdDAHalhgMAUhZoXsGgTCqbAwhVBgdNDPxn-U0CtEqSsWwDAKy041UtqLZVwu2
7bGTZeOxq6hsfjA2FzoKeL8z9I65WE

>
< HTTP/1.1 200 OK
< Date: Fri, 15 May 2015 13:17:58 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"properties":[{"key":"name","values":["kim","Huge"]},{"key":"email","values":["kim@yahoo.com","huge@yahoo.com"]},{"key":"surname","values":"Smith"}]}

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <METADATA_API_TOKEN>" -k -v https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/metadata/api/applications/{application_id}/clusters/{cluster_id}/properties

  • 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 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjExNzcxNTU4
MDUsInN1YiI6ImFkbWluIiwiYXpwIjoiS05QVGNZZ0R6ZkxWTVVTWTFSSV9hZ1J1X1ZBYSIsImFwcElkIjoic2luZ2xlLWNhcnRyaWRnZ
S1hcHAiLCJhdWQiOlsiS05QVGNZZ0R6ZkxWTVVTWTFSSV9hZ1J1X1ZBYSJdLCJpc3MiOiJ
odHRwczpcL1wvbG9jYWxob3N0Ojk0NDNcL29hdXRoMmVuZHBvaW50c1wvdG9rZW4iLCJpYXQiOjExN
zcxNTY4MDZ9.fsJ8gOUWxyT_JhUkOQ_eG1Q5Z5cXdaKUKUhJppBK0Sejd7QhW5sZHXzWcNgO96yLPx7HOoi
uVGbEVmf2Hjka_ARGRaEu51BZsXenu1X6FCSf7QXdU8n5MtD-xDuAIApxNl0TJ8J8cvcouDySYz
KSP6x93kYTIRp9ubujxQgiEZc" -v https://localhost:9443/metadata/api/applications/wordpress/clusters/wordpress.my-php.php.domain/properties

 

REST API response

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

{  
   "properties":[  
      {  
         "key":"name",
         "values":[  
            "kim",
            "Huge"
         ]
      },
      {  
         "key":"email",
         "values":[  
            "kim@yahoo.com",
            "huge@yahoo.com"
         ]
      },
      {  
         "key":"surname",
         "values":"Smith"
      }
   ]
}
  • No labels