Jump to

• Request
• Response

View This Trigger Runtime

get

/management/weblogic/{version}/serverRuntime/partitionRuntimes/{name}/resourceManagerRuntime/resourceRuntimes/{name}/triggerRuntimes/{name}

View this trigger runtime.

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 trigger runtime.

Body ()

Root Schema : Trigger Runtime

Type: object

Show Source

• activated(optional): boolean
  Read Only: true

  Indicates if the Trigger is Activated

• initiated(optional): boolean
  Read Only: true

  Indicates if a recourse action has been initiated for this Trigger as a result of the current resource usage by a Domain Partition exceeding its usage limit. A new RecourseActionEventVBean is added to the array returned by getRecourseActionEventsHistory().

  The kind of recourse action initiated (for example, a new recourse action or a withdrawal of an existing recourse action) can be determined through RecourseActionEventVBean#isActive().

• lastTimeExecuted(optional): string(date-time)
  Read Only: true

  The Date when the last recourse action was successfully executed for the current Trigger.

  This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX
• name(optional): string
  Read Only: true

  The name of the Trigger, as configured in the Resource Consumption Management policy of the Domain Partition.

• recourseActionEventsHistory(optional): array Items
  Title: Items

  Read Only: true

  A list of recourse action events that have been initiated and executed.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "activated":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates if the Trigger is <i>Activated</i></p>"
        },
        "initiated":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates if a recourse action has been initiated for this Trigger as a result of the current resource usage by a Domain Partition exceeding its usage limit. A new <code>RecourseActionEventVBean</code> is added to the array returned by getRecourseActionEventsHistory(). </p><p> The kind of recourse action initiated (for example, a new recourse action or a withdrawal of an existing recourse action) can be determined through RecourseActionEventVBean#isActive(). </p>"
        },
        "lastTimeExecuted":{
            "readOnly":true,
            "type":"string",
            "format":"date-time",
            "description":"<p>The <code>Date</code> when the last recourse action was successfully executed for the current Trigger.</p> This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the Trigger, as configured in the Resource Consumption Management policy of the Domain Partition.</p>"
        },
        "recourseActionEventsHistory":{
            "readOnly":true,
            "title":"Items",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Recourse Action Event V"
            },
            "description":"<p>A list of recourse action events that have been initiated and executed.</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

A list of recourse action events that have been initiated and executed.

Show Source

• Array of: object Recourse Action Event V

{
    "readOnly":true,
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Recourse Action Event V"
    },
    "description":"<p>A list of recourse action events that have been initiated and executed.</p>"
}

Nested Schema : Recourse Action Event V

Type: object

Show Source

• action(optional): string
  Read Only: true

  The recourse action type configured in the Domain Partition's Resource Consumption Management policy for the current Trigger.

• actionSuccessful(optional): boolean
  Read Only: true

  Indicates if the recourse action execution was successfully completed.

• active(optional): boolean
  Read Only: true

  Indicates if the recourse action is a new execution of a recourse action because the usage limit is exceeded or the withdrawal of an existing recourse action because the current resource usage has gone below the usage limit.

• executionDate(optional): string(date-time)
  Read Only: true

  The date and time the recourse action successfully executes.

  This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX
• initiated(optional): boolean
  Read Only: true

  Indicates if a recourse action has been initiated for this Trigger as a result of the current resource usage by a Domain Partition exceeds its usage limit.

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

  The current resource usage by the Domain Partition when the recourse action was initiated.

{
    "type":"object",
    "properties":{
        "action":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The recourse action type configured in the Domain Partition's Resource Consumption Management policy for the current Trigger.</p>"
        },
        "actionSuccessful":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates if the recourse action execution was successfully completed.</p>"
        },
        "active":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates if the recourse action is a new execution of a recourse action because the usage limit is exceeded or the withdrawal of an existing recourse action because the current resource usage has gone below the usage limit.</p>"
        },
        "executionDate":{
            "readOnly":true,
            "type":"string",
            "format":"date-time",
            "description":"<p>The date and time the recourse action successfully executes.</p> This value represents a date as a string in ISO 8601 format, yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
        },
        "initiated":{
            "readOnly":true,
            "type":"boolean",
            "description":"<p>Indicates if a recourse action has been initiated for this Trigger as a result of the current resource usage by a Domain Partition exceeds its usage limit.</p>"
        },
        "usage":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>The current resource usage by the Domain Partition when the recourse action was initiated.</p>"
        }
    },
    "description":""
}

Back to Top