Jump to

• Request
• Response

View This SAF Runtime

get

/management/weblogic/{version}/serverRuntime/SAFRuntime

View this SAF runtime.

Request

Path Parameters

• version: string
  The version of the WebLogic 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

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this SAF runtime.

This method can return the following links:

• rel=agents uri=/management/weblogic/{version}/serverRuntime/SAFRuntime/agents

  This resource's agents collection resource.

Body ()

Root Schema : SAF Runtime

Type: object

Show Source

• healthState(optional): object Health State

  Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

• name(optional): string
  Read Only: true

  The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

  Constraints

  • unharvestable
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "healthState":{
            "readOnly":true,
            "$ref":"#/definitions/Health State"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Health State

Type: object

Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.

Show Source

• partitionName(optional): string

  This property indicates the partition name for which the health state is reported.

• state(optional): string

  This property indicates the reported state as:

  • OK - Service is healthy.

  • WARN - Service could have problems in the future

  • CRITICAL - Something must be done now to prevent service failure

  • FAILED - Service has failed and must be restarted

  • OVERLOADED - Service is functioning normally but there is too much work in it

  • UNKNOWN - Service state cannot be determined

• subsystemName(optional): string

  This property indicates the service for which the health state is reported.

• symptoms(optional): array Items
  Title: Items

  This property indicates the cause of the reported state.

{
    "type":"object",
    "properties":{
        "partitionName":{
            "type":"string",
            "description":"<p>This property indicates the partition name for which the health state is reported.</p>"
        },
        "state":{
            "type":"string",
            "description":"<p>This property indicates the reported state as:</p><ul><li><p>OK - Service is healthy.</p></li><li><p>WARN -  Service could have problems in the future</p></li><li><p>CRITICAL - Something must be done now to prevent service failure</p></li><li><p>FAILED - Service has failed and must be restarted</p></li><li><p>OVERLOADED -  Service is functioning normally but there is too much work in it</p></li><li><p>UNKNOWN - Service state cannot be determined</p></li></ul>"
        },
        "subsystemName":{
            "type":"string",
            "description":"<p>This property indicates the service for which the health state is reported.</p>"
        },
        "symptoms":{
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Symptom"
            },
            "description":"<p>This property indicates the cause of the reported state.</p>"
        }
    },
    "description":"<p>Represents the health of the services that are in a WebLogic server domain. Selected subsystems within each WebLogic Server instance monitor their health status based on criteria specific to the subsystem.</p>"
}

Nested Schema : Items

Type: array

Title: Items

This property indicates the cause of the reported state.

Show Source

• Array of: object Symptom

  Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Symptom"
    },
    "description":"<p>This property indicates the cause of the reported state.</p>"
}

Nested Schema : Symptom

Type: object

Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.

Show Source

• info(optional): string

  This property provides additional information about the symptom if available.

• instanceId(optional): string

  This property represents an identifier for the symptom.

• severity(optional): string

  This property indicates a low, medium, or high severity level.

• type(optional): string

  This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).

{
    "type":"object",
    "properties":{
        "info":{
            "type":"string",
            "description":"<p>This property provides additional information about the symptom if available.</p>"
        },
        "instanceId":{
            "type":"string",
            "description":"<p>This property represents an identifier for the symptom.</p>"
        },
        "severity":{
            "type":"string",
            "description":"<p>This property indicates a low, medium, or high severity level.</p>"
        },
        "type":{
            "type":"string",
            "description":"<p>This property represents the cause of the symptom (low memory, network error, stuck threads, and so on).</p>"
        }
    },
    "description":"<p>Represents an observation reported by a service with its health state. A symptom can be used to determine the reason for the current health state of a WebLogic server.</p>"
}

Back to Top