Pod search request

Description

This API searches for Pod objects that satisfy the specified criteria.

API stability classification

Uncommitted

API overview

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Input parameters to include in operationParams

If you include both the fillFields and ignoreFields parameters in your query and the same field is listed in both parameters, the ignoreFields parameter takes precedence.

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a SearchResults object in which the results field is an array of Pod objects. If your search request times out before it finishes, the response message body contains a Task object.

Example

The following example shows an HTTP request that searches for pods:

POST /csm/pod/search HTTP/1.1
Host: <apiServer>
Authentication-Token: <yourToken>

The following example shows an HTTP response to the previous request:

Date: Wed, 30 Mar 2011 20:54:00 GMT
BMC-Transaction-ID: 96b389f6-cc29-4d37-a900-72a2df61beb3
Content-Type: application/json; charset=UTF-8
Content-Length: 1180
Server: Jetty(6.1.x)

[
   {
     "cloudClass" : "com.bmc.cloud.model.beans.SearchResults",
     "guid" : "24882bd8-e62c-4a16-896b-6f35882ab393",
     "pageNo" : 0,
     "pageSize" : 0,
     "results" : [
         {
           "cloudClass" : "com.bmc.cloud.model.beans.Pod",
           "containerBlueprints" :
               [ "/containerblueprint/cd012059-7e45-4deb-b79e-9f122747fbf4" ],
           "containers" :
               ["/networkcontainer/04e36fa8-9f8e-4415-a7c7-60b88b349e4d"],
           "externalID" : "52cfae96-730b-43ee-b530-cdcc99ebfd99:CompactPODDev",
           "guid" : "5304ea7c-7992-4b00-9456-b4a45620f715",
           "isOnboarded" : true,
           "location" : "/location/OI-9D874CF0111E4C449FE68A5E622B74ED",
           "name" : "CompactPODDev",
           "networks" : [ "/network/56455651-302e-43f7-9611-7bb6ae45f3e0" ],
           "owner" : "bhu_admin",
           "provider" : "/provider/52cfae96-730b-43ee-b530-cdcc99ebfd99",
           "reconciliationID" : "OI-4529607eefc44db89a23c65276302e60",
           "staticPools" : [
              "/staticpool/51354b3d-75cd-406e-bf53-051244e76125",
              "/staticpool/65cd213f-4a54-480f-bb4d-03b12b262924",
              "/staticpool/6698006d-e13d-44d1-8fa9-b99bebd05eaf",
              "/staticpool/d2e369cf-5382-48cc-b489-585e31f2d7eb"
            ],
           "tokenID" : "CompactPODDev"
         }
      ],
     "totalRows" : 1
   }
]