LogicalHostingEnvironment search request
Description
This API searches for LogicalHostingEnvironment objects that satisfy the specified criteria.
API stability classification
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 LogicalHostingEnvironment 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 logical hosting environments:
POST /csm/logicalhostingenvironment/search
Host: apiServer.calbro.com:8080
Authentication-Token: AQIC5wM2LY4Sfcx705TK5UqUK6Ythuk1tVWjHMl7/rpY0Ys=@REGUSER232864
{
"operationParams":[
{
"name":"pageSize",
"type":"java.lang.Integer",
"multiplicity":"0..1",
"value":2
}
]
}
The following example shows a response to the previous HTTP request:
HTTP/1.1 200 OK
BMC-Transaction-ID: bacd4590-d442-4993-b7d8-ff7b73611d77
Content-Length: 2506
Content-Type: application/json; charset=UTF-8
Date: Wed, 07 Nov 2012 22:44:50 GMT
Server: Jetty(6.1.x)
Session-ID: 1626dbd5-9c9c-47a4-8ffb-ed7f33a3f3b3
[
{
"cloudClass":"com.bmc.cloud.model.beans.SearchResults",
"guid":"89cf5223-a3da-4bc1-a20b-12d6fb4635e2",
"pageNo":0,
"pageSize":2,
"results":[
{
"cloudClass":"com.bmc.cloud.model.beans.LogicalHostingEnvironment",
"guid":"0fc4b5da-43d7-48b6-b29b-f7b5ee1efb87",
"logicalNetwork":[
"/logicalnetwork/3a5492cc-afd3-4973-bcfa-0bf15a1fee18",
"/logicalnetwork/a660d188-ff4f-437f-b8ad-ec96c63b8d9d",
"/logicalnetwork/f74405a3-186d-428c-8285-1d714d85fc00"
],
"name":"VSG NC",
"organization":[
"/organization/OI-3793E78A50F44141A349657D3B89BEC0"
],
"owner":"cladmin_hb",
"provider":"/provider/84745d70-d2cb-487c-b300-6ea60386ffcd",
"reconciliationID":"OI-74adc6f7abf74bf190a9fd4e48399ee7",
"resourceHostingEnvironment":"/networkcontainer/a5e9ab2b-3591-4602-87af-632ded474201",
"state":"Failed",
"tags":[
],
"tokenID":"0fc4b5da-43d7-48b6-b29b-f7b5ee1efb87"
},
{
"cloudClass":"com.bmc.cloud.model.beans.LogicalHostingEnvironment",
"description":"Description new",
"guid":"1a14a5b0-296e-4667-b3f8-2e63bfce95ef",
"logicalNetwork":[
"/logicalnetwork/4302be30-19b9-4d8a-9dad-fdfe6f8f9546",
"/logicalnetwork/d21d876e-63de-499b-a977-dd4e8af720b4",
"/logicalnetwork/42bb2ca0-508f-461a-bcb5-fef217fac9fa",
"/logicalnetwork/e08922f5-7ddc-4e7d-87f2-55b54afadd91"
],
"name":"AJ_NAT_v10",
"organization":[
],
"owner":"sudesh_admin",
"provider":"/provider/84745d70-d2cb-487c-b300-6ea60386ffcd",
"reconciliationID":"OI-0c93deb8ba464d0d92827a6fcbbe1a37",
"resourceHostingEnvironment":"/networkcontainer/19ced1aa-5a38-4e54-8746-92416003ae26",
"state":"Active",
"tags":[
{
"cloudClass":"com.bmc.cloud.model.beans.Tag",
"guid":"561c7d3b-00cc-4cfd-8f9c-b6f307f822ce",
"label":"Dynamic",
"name":"Dynamic",
"tagGroup":{
"cloudClass":"com.bmc.cloud.model.beans.TagGroup",
"guid":"3b297000-676d-4c82-b305-c674bdc33c2f",
"name":"NetworkContainerType",
"ownedTags":[
"/tag/Compact Gold",
"/tag/Compact",
"/tag/Dynamic",
"/tag/Multi"
]
},
"tagGroupObject":{
"cloudClass":"com.bmc.cloud.model.beans.TagGroup",
"description":"@circular-reference-placeholder@",
"guid":"3b297000-676d-4c82-b305-c674bdc33c2f"
}
}
],
"tokenID":"1a14a5b0-296e-4667-b3f8-2e63bfce95ef"
}
],
"totalRows":9
}
]