Visit Platform at http://www.platform.com

MonitoringService

Operation: ClusterInfo The operation is used to retrieve meta data about the EGO cluster. At this time, the information for only one EGO cluster is reported, but in future this operation might return information about all known EGO clusters.
Input Message

Currently, the request message for ClusterInfo is an empty element tag (<ClusterInfoRequest/>).

Output Message

One or more ClusterInfo elements are returned.


Operation: EgoInfo The operation is used to retrieve configuration data about EGO.
Input Message

Currently, the request message for EgoInfo includes name of the configuration item and optional EGO configuration file pathname.

Output Message

Value of the specified configuration item is returned.


Operation: ResourceInfo This operation is used to get information about the resources that are managed by an EGO cluster. Resources can be queried by name, or by providing a resource requirement string, or both.
Input Message

The request contains the following sub-elements:

  • ResourceRequirement - an optional resource requirement string that provides a constraint on which resources to provide information about.
  • ResourceName - zero or more elements explicitly listing which resources to provide information about. If there is also a ResourceRequirement, then ResourceName must match the resource requirement string in order to have its information reported.
Output Message

Zero or more Resource elements are returned.


Operation: ResourceAttributes This operation is used to itemize the attributes that are reported within a set of EGO resources. That is, the name and type of each attribute contained within a set of resources is provided.
Input Message

This request contains the following sub-elements:

  • ResourceRequirement - an optional resource requirement string that provides a constraint on which resources to provide information about.
  • ResourceName - zero or more elements explicitly listing which resources to provide information about. If there is also a ResourceRequirement, then ResourceName must match the resource requirement string in order to have its attribute information reported.
Output Message

Zero or more Attribute elements are returned. The elements returned have 'nil' values, as only the attribute meta data is being provided.


Operation: ActivityInfo This operation is used to obtain information of activities filtered by specified activity IDs,consumer IDs and resource names. Only activities whose activity ID ,consumer ID and resource name attribute matches those specifed could pass filter.
Input Message

Request that contains the following elements:

  • Activiy IDs - a sequence of activity IDs from which to choose activities.
  • Consumer IDs - a sequence of consumer IDs from which to choose activities.
  • Resource names - a sequence of resource names from which to choose activities.
Output Message

Response that includes all those activities that pass filter.


Operation: GetDefinedHostType This operation is used to query EGO for all host types that are currently active. Active means there is at least one host belonging to EGO with the given host type.
Input Message

The request of this operation is empty.

Output Message

This response contains the following sub-elements:

  • HostTypesNumber - number of host types.
  • HostTypeName - host types names, array size equal to "num".

Operation: GetHostSummary This operation is used to retrieve host summary information.
Input Message

The request of this operation is empty.

Output Message

This response contains the following sub-elements:

  • hostNumber - number of hosts.
  • statusNumber - number of status.
  • statusName - name of status, array size is "statusC".
  • statusSummary - number of hosts by status, array size is "statusC".
  • utNumber - number of ut interval.
  • utName - name of each interval (ie: 0%, 10% ... etc).
  • utSummary - number of hosts by each ut interval, array size equal to "utC".

Operation: GetLogonUser This operation is used to retrive logon user's name. This operation is uesd after logon.
Input Message

The request of this operation is empty.

Output Message

This response contains the following sub-elements:

  • userName - The name of Logon user.

Operation: GetSignal This operation is used to translate signal string to signal num.
Input Message

This request contains the following sub-elements:

  • Signal - signal string. eligible string is "1", "16" "QUIT", "USR1" ... , "SIGQUIT", ...
Output Message

This response contains the following sub-elements:

  • Signum - the signal num of the request signal string.

Operation: GetTimeIntervals This operation is used to retrieve time window according the request resource group name.
Input Message

This request contains the following sub-elements:

  • ResourceGroupName - An identifier that uniquely identifies a particular ResourceGroup.within the EGO cluster.
Output Message

This response contains the following sub-elements:

  • TimeIntervals - time window.

Operation: VerifyConsumerPath This operation is used to verify consumer path is valid or not.
Input Message

This request contains the following sub-elements:

  • ConsumerID - The full pathname of consumer.
  • ResourceGroupName - An identifier that uniquely identifies a particular ResourceGroup.within the EGO cluster.It is optional.
Output Message

This response contains the following sub-elements:

  • valid - if the request ConsumerPath is valid, the response is true, otherwise is false.

Operation: VerifyResourceRequirement This operation is used to Verify resource requirement string's syntax is correct or not. Does not do any logical check to see if the resource requirement will ever be satisfied.
Input Message

This request contains the following sub-elements:

  • ResourceRequirement - A string that provides a resource requirement specification.
Output Message

This response contains the following sub-elements:

  • valid - if resource requirement is valid return true, false if resource requirement is not valid.

Operation: AvailableResourceForConsumer This operation is for querying Available Resource of Consumer.
Input Message

This request contains the following sub-elements:

  • ConsumerID - Specifies the fully-qualified name of a consumer in the consumer tree. For example: "/DeptA/ProjB/ConsumerC" indicates that ConsumerC is part of ProjB, which is in turn part of DeptA.
  • ResourceGroupName - Identifies a particular resource group within the EGO cluster. Specify a unique name of up to 120 alphanumeric characters, including underscores and dashes.
Output Message

This response contains the following sub-elements:

  • Resource - This element represents the most basic manageable entity within EGO. A Resource is basically a set of name/value pairs (as modelled by Attribute elements), which has a state, and a description of which attribute is consumable within allocations. an Resource has 4 attributs: 1) AllocatedCPUs : the resource(CPU) number the consumer has allocated. 2) IdleCPUs : the idle resource(CPU) number. 3) BorrowPotentialCPUs : the number of potentially available resource (CPU) for lending to the consumer. 4) ReclaimPotentilCPUs : the number of potentially available resource (CPU) for reclaiming from the consumer.



Date Modified: 26 Nov 2007
Platform Computing: www.platform.com

Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Copyright © 1994-2007 Platform Computing Corporation. All rights reserved.