Viewing the status of destination mapping rules by using REST Administration APIs

System administrators can view the status of a destination mapping rule, along with other statistics, by using a REST Administration API.

You can use the REST API GET method to view monitoring statistics about destination mapping rules in a monitoring domain. You can also use the REST API GET method to view configuration information about destination mapping rules in configuration domain.

The information that is returned in a monitoring domain is not the same as the information that is returned when in a configuration domain. The monitoring domain returns statistical information, including the status of one or more destination mapping rules. The configuration domain returns the configuration information for the rule.

For more information about the configuring URI command, see Viewing a destination mapping rule by using REST Administration APIs.

You can view the status of a destination mapping rule by using a REST Administration API, or by using the Amlen WebUI. For more information about using the Amlen WebUI to view the status of destination mapping rules, see Configuring destination mapping rules by using the Amlen WebUI.
  1. To view the status of one or more destination mapping rules, use the Eclipse Amlen REST API GET method with the following Eclipse Amlen monitoring URI:

    http://<admin-endpoint-IP:Port>/ima/v1/monitoring/DestinationMappingRule

  2. Provide query parameters requesting the statistics that you want returned in the JSON payload. The following example uses cURL to create queue-related statistics: 
    curl -X GET http://10.10.2.149:9087/ima/v1/monitor/DestinationMappingRule?Name=Name%26RuleType=RuleType
%26Association=queueManagerConnection%26ResultCount=ResultCount

    where

    • Name
      Optional.
      Specifies the name of the destination mapping rule that you want to view the status of.
      You can use an asterisk (*) as a wildcard to specify a group of destination mapping rules. For example, to view the status of all destination mapping rules that start with MQ, use MQ*
      The default value is *
    • RuleType
      Optional.
      Specifies the type of rule to return the status of.
      You can specify one of the following values:
      IMATopicToMQQueue
      Returns destination mapping rules of the type Eclipse Amlen topic to IBM® MQ queue.
      IMATopicToMQTopic
      Returns destination mapping rules of the type Eclipse Amlen topic to IBM MQ topic.
      MQQueueToIMATopic
      Returns destination mapping rules of the type IBM MQ queue to Eclipse Amlen topic.
      MQTopicToIMATopic
      Returns destination mapping rules of the type IBM MQ topic to Eclipse Amlen topic.
      IMATopicSubtreeToMQQueue
      Returns destination mapping rules of the type Eclipse Amlen topic subtree to IBM MQ queue.
      IMATopicSubtreeToMQTopic
      Returns destination mapping rules of the type Eclipse Amlen topic subtree to IBM MQ topic.
      IMATopicSubtreeToMQTopicSubtree
      Returns destination mapping rules of the type Eclipse Amlen topic subtree to IBM MQ topic subtree.
      MQTopicSubtreeToIMATopic
      Returns destination mapping rules of the type IBM MQ topic subtree to Eclipse Amlen topic.
      MQTopicSubtreeToIMATopicSubtree
      Returns destination mapping rules of the type IBM MQ topic subtree to Eclipse Amlen topic subtree.
      IMAQueueToMQQueue
      Returns destination mapping rules of the type Eclipse Amlen queue to IBM MQ queue.
      IMAQueueToMQTopic
      Returns destination mapping rules of the type Eclipse Amlen queue to IBM MQ topic.
      MQQueueToIMAQueue
      Returns destination mapping rules of the type IBM MQ queue to Eclipse Amlen queue.
      MQTopicToIMAQueue
      Returns destination mapping rules of the type IBM MQ topic to Eclipse Amlen queue.
      MQTopicSubtreeToIMAQueue
      Returns destination mapping rules of the type IBM MQ topic subtree to Eclipse Amlen queue.
      Any
      Returns destination mapping rules of all types.
      The default value is any.
    • queueManagerConnection
      Optional.
      Specifies the queue manager connection that the destination mapping rule must be associated with to have the rule status returned.
      You can use an asterisk (*) as a wildcard to specify a group of queue manager connections. For example, to view the status of all destination mapping rules that are associated with queue managers that start with MQ, use MQ*
      The default value is *
    • ResultCount
      Optional.
      Specifies how many results to return.
      This value can be one of the following values: 10, 25, 50, 100.
      The default value is 25.
The following fields are returned:
  • 0
    Enabled.
    The rule is operating normally.
  • 1
    Disabled.
    The rule is not operating. The rule must be restarted by an administrator.
  • 2
    Reconnecting.
    The rule encountered a problem. Eclipse Amlen is attempting to restart the rule.
  • 3
    Starting.
    The rule is being activated.

The following example uses cURL to show how a GET method is used to create the most recent statistics about a destination mapping rule called MyDestinationMappingRule:

curl -X GET http://127.0.0.1:9089/ima/v1/monitor/DestinationMappingRule?Name=MyDestinationMappingRule

The following example shows a successful example response to the GET method that was used to create the most recent statistics about a destination mapping rule called MyDestinationMappingRule:

{ "Version":"v1", "DestinationMappingRule": [ { "Name":"MyDestinationMappingRule " }
 ] }

The following example shows an unsuccessful example response to the GET method that was used to create the most recent statistics about a destination mapping rule called MyDestinationMappingRule:

{ "Version":"v1","Code":"CWLNA0113","Message":"The requested item is not found." }