View This Collection Of Runtimes
get
/management/lifecycle/{version}/runtimes
The GET method on this resource returns a list of runtimes.
Roles
Admin, Deployer, Monitor, Operator
Request
Path Parameters
-
version: string
The version of the WebLogic Lifecycle REST interface.
Query Parameters
-
excludeFields(optional): string
The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
-
excludeLinks(optional): string
The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
-
fields(optional): string
The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
-
links(optional): string
The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.
Security
-
Admin: basic
Type:
basic
-
Deployer: basic
Type:
basic
-
Monitor: basic
Type:
basic
-
Operator: basic
Type:
basic
Response
Supported Media Types
- application/json
200 Response
The response body returned includes a collection of runtime entities.
This method can return the following links:
- rel=create-form uri=/management/lifecycle/{version}/runtimeCreateForm
Root Schema : Items
Type:
array
Title:
Show Source
Items
-
Array of:
object Runtime
Includes the name, type, host and port for a physical runtime. It can also include arbitrary properties.
Nested Schema : Runtime
Type:
object
Includes the name, type, host and port for a physical runtime. It can also include arbitrary properties.
Show Source
-
hostName(optional):
string
The hostname of the runtime.
-
name(optional):
string
The name of the runtime.
-
port(optional):
string
The port of the runtime.
-
properties(optional):
array properties
Arbitrary properties. These may include the username and password that are required to connect to the runtime.
-
protocol(optional):
string
The protocol of the runtime.
-
type(optional):
string
The type of the runtime.
Nested Schema : properties
Type:
array
Arbitrary properties. These may include the username and password that are required
to connect to the runtime.
Show Source
-
Array of:
object Property
Holds a named property, where the value can be a String, a confidential String, or a list of Properties.
Nested Schema : Property
Type:
object
Holds a named property, where the value can be a String, a confidential String, or a list of Properties.
Show Source
-
confidentialValue(optional):
string
Property Confidential String value.
-
properties(optional):
array properties
Property Properties value.
-
values(optional):
array values
Property String values.
Nested Schema : properties
Type:
array
Property Properties value.
Show Source
-
Array of:
object Property
Holds a named property, where the value can be a String, a confidential String, or a list of Properties.
Nested Schema : values
Type:
array
Property String values.
Show Source
-
Array of:
object Property
Holds a named property, where the value can be a String, a confidential String, or a list of Properties.
Examples
Viewing a List of Runtimes
This example uses the GET method to display a list of runtimes.
Example Request
curl -v \ --user username:password \ -H X-Requested-By:MyClient \ -H Accept:application/json \ -X GET http://localhost:7001/management/lifecycle/latest/runtimes
Example Response
HTTP/1.1 200 OK Response Body: { "items": [ { "links": [ { "rel": "canonical", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime" }, { "rel": "self", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes\/WLSRuntime" } ], "name": "WLSRuntime", "properties": [ { "name": "password", "value": "password" }, { "name": "username", "value": "username" } ], "type": "wls", "protocol": "http", "port": "7001", "hostName": "localhost" } ], "links": [ { "rel": "parent", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest" }, { "rel": "self", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes" }, { "rel": "canonical", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimes" }, { "rel": "create-form", "href": "http:\/\/localhost:7001\/management\/lifecycle\/latest\/runtimeCreateForm" } ] }Back to Top