Jump to

• Request
• Response

View This WLDF Harvester

get

/management/weblogic/{version}/serverConfig/servers/{name}/serverDiagnosticConfig/WLDFBuiltinSystemResourceDescriptorBean/harvester

View this WLDF harvester.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• 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.

This method can return the following links:

• rel=harvestedTypes uri=/management/weblogic/{version}/serverConfig/servers/{name}/serverDiagnosticConfig/WLDFBuiltinSystemResourceDescriptorBean/harvester/harvestedTypes

  This resource's harvestedTypes collection resource.

Body ()

Root Schema : WLDF Harvester

Type: object

Show Source

• enabled(optional): boolean
  Default Value: true

  Specifies whether the Harvester component is enabled.

  If true, all types that are both configured and enabled are harvested. If false, nothing is harvested.

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

  Return the unique id of this bean instance.

• name(optional): string
  Read Only: true

  The name of the WebLogic Diagnostic Framework (WLDF) bean.

• samplePeriod(optional): integer(int64)
  Minimum Value: 1000

  Default Value: 300000

  The interval, in milliseconds, between samples.

{
    "type":"object",
    "properties":{
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether the Harvester component is enabled.</p><p>If <code>true</code>, all types that are both configured and enabled are harvested. If <code>false</code>, nothing is harvested.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the WebLogic Diagnostic Framework (WLDF) bean.</p>"
        },
        "samplePeriod":{
            "default":300000,
            "minimum":1000,
            "type":"integer",
            "format":"int64",
            "description":"<p>The interval, in milliseconds, between samples.</p>"
        }
    },
    "description":""
}

Back to Top