Jump to

• Request
• Response

View This WLDF Harvester Runtime

get

/management/weblogic/{version}/serverRuntime/WLDFRuntime/WLDFHarvesterRuntime

View this WLDF harvester 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 WLDF harvester runtime.

Body ()

Root Schema : WLDF Harvester Runtime

Type: object

Show Source

• averageSamplingTime(optional): integer(int64)
  Read Only: true

  The average amount of time, in nanoseconds, spent in sampling cycles.

• knownHarvestableTypes(optional): array Items
  Title: Items

  Read Only: true

  The set of all known types, regardless of whether the types are currently configured for harvesting. The set includes the WebLogic Server MBeans, which are always present, plus any other types that can be discovered. MBeans that are not WebLogic Server MBeans will require instances to exist in order to discover the type.

  Constraints

  • unharvestable
• maximumSamplingTime(optional): integer(int64)
  Read Only: true

  The maximum sampling time, in nanoseconds.

• minimumSamplingTime(optional): integer(int64)
  Read Only: true

  The minimum sampling time, in nanoseconds.

• name(optional): string
  Read Only: true

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

  Constraints

  • unharvestable
• totalSamplingCycles(optional): integer(int64)
  Read Only: true

  The total number of sampling cycles taken thus far.

• totalSamplingTime(optional): integer(int64)
  Read Only: true

  The total amount of time, in nanoseconds, spent in sampling cycles.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "averageSamplingTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> The average amount of time, in nanoseconds, spent in sampling cycles. </p>"
        },
        "knownHarvestableTypes":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The set of all known types, regardless of whether the types are currently configured for harvesting. The set includes the WebLogic Server MBeans, which are always present, plus any other types that can be discovered. MBeans that are not WebLogic Server MBeans will require instances to exist in order to discover the type.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "maximumSamplingTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> The maximum sampling time, in nanoseconds. </p>"
        },
        "minimumSamplingTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> The minimum sampling time, in nanoseconds. </p>"
        },
        "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>"
        },
        "totalSamplingCycles":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> The total number of sampling cycles taken thus far. </p>"
        },
        "totalSamplingTime":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> The total amount of time, in nanoseconds, spent in sampling cycles. </p>"
        },
        "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 : Items

Type: array

Title: Items

Read Only: true

The set of all known types, regardless of whether the types are currently configured for harvesting. The set includes the WebLogic Server MBeans, which are always present, plus any other types that can be discovered. MBeans that are not WebLogic Server MBeans will require instances to exist in order to discover the type.

Constraints

• unharvestable

Show Source

• Array of: string

{
    "readOnly":true,
    "x-weblogic-unharvestable":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The set of all known types, regardless of whether the types are currently configured for harvesting. The set includes the WebLogic Server MBeans, which are always present, plus any other types that can be discovered. MBeans that are not WebLogic Server MBeans will require instances to exist in order to discover the type.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
}

Back to Top