+

Search Tips | Advanced Search

Response body attributes for channels

When you receive the response body from using the HTTP verb GET with the channel object to request information about channels, attributes for the channels are returned within named JSON objects.

The following objects are available:

For more information about the PCF equivalents to the queue REST API parameters and attributes, see REST API and PCF equivalents for channels.

Note: The REST API supports only channels that have TCP as their transport type, and are of type sender, receiver, server, requester, cluster-sender, or cluster-receiver. Other channels are not returned.


sender

The sender object contains information about sender channels and is returned only for sender channels:

    connection
    An array of JSON objects that can contain the following attributes that define the channel connection:

      host
      String.
      Specifies the host that this channel connects to.

      port
      Integer.
      Specifies the port that this channel uses on this host.
      This attribute cannot be used to filter results.

    These attributes are always returned if they are available. If no connection information is available, an empty array is returned. If the connection does not conform to the expected syntax, an array containing a single host attribute having the value of the entire connection is returned.

    transmissionQueueName
    String.
    Specifies the name of the transmission queue in use by this channel.
    This attribute is always returned.


server

The server object contains information about server channels and is returned only for server channels:

    connection
    An array of JSON objects that can contain the following attributes that define the channel connection:

      host
      String.
      Specifies the host that this channel connects to.

      port
      Integer.
      Specifies the port that this channel uses on this host.
      This attribute cannot be used to filter results.

    These attributes are always returned if they are available. If no connection information is available, an empty array is returned. If the connection does not conform to the expected syntax, an array containing a single host attribute having the value of the entire connection is returned.

    transmissionQueueName
    String.
    Specifies the name of the transmission queue in use by this channel.
    This attribute is always returned.


requester

The requester object contains information about requester channels and is returned only for requester channels:

    connection
    An array of JSON objects that can contain the following attributes that define the channel connection:

      host
      String.
      Specifies the host that this channel connects to.

      port
      Integer.
      Specifies the port that this channel uses on this host.
      This attribute cannot be used to filter results.

    If no connection information is available, an empty array is returned.
    If the connection does not conform to the expected syntax, an array containing a single host attribute having the value of the entire connection is returned.


clusterSender

The clusterSender object contains information about cluster sender channels and is returned only for cluster sender channels:

    connection
    An array of JSON objects that can contain the following attributes that define the channel connections:

      host
      String.
      Specifies the host that this channel connects to.

      port
      Integer.
      Specifies the port that this channel uses on this host.
      This attribute cannot be used to filter results.

    These attributes are always returned if they are not empty. If no connection information is available, an empty array is returned.
    If the connection does not conform to the expected syntax, an array containing a single host attribute having the value of the entire connection is returned.

    clusterName
    String.
    Specifies the name of the cluster to which the channel belongs.
    This attribute is always returned if it is not empty.

    clusterNamelist
    String.
    Specifies a list of clusters to which the channel belongs.
    This attribute is always returned if it is not empty.


clusterReceiver

The clusterReceiver object contains information about cluster receiver channels and is returned only for cluster receiver channels:

    connection
    An array of JSON objects that can contain the following attributes that define the channel connections:

      host
      String.
      Specifies the host that this channel connects to.

      port
      Integer.
      Specifies the port that this channel uses on this host.
      This attribute cannot be used to filter results.

    These attributes are always returned if they are not empty. If no connection information is available, an empty array is returned.
    If the connection does not conform to the expected syntax, an array containing a single host attribute having the value of the entire connection is returned.

    clusterName
    String.
    Specifies the name of the cluster to which the channel belongs.
    This attribute is always returned if it is not empty.

    clusterNamelist
    String.
    Specifies a list of clusters to which the channel belongs.
    This attribute is always returned if it is not empty.


clusterRouting

The clusterRouting object contains information about routing within clusters and is returned only for cluster receiver and cluster sender channels:

    workloadPriority
    Integer.
    Specifies the channel priority for cluster workload distribution.
    A value of 0 specifies the lowest priority and a value of 9 specifies the highest priority.

    workloadRank
    Integer.
    Specifies the channel rank for cluster workload distribution.
    A value of 0 specifies the lowest rank and a value of 9 specifies the highest rank.

    workloadWeight
    Integer.
    Specifies channel weighting for cluster workload distribution.
    A value of 1 specifies the lowest weight and a value of 99 specifies the highest weight.

    networkPriority
    Integer.
    Specifies priority for the network connection. If there are multiple paths available, distributed queuing selects the path with the highest priority.
    A value of 0 specifies the lowest priority and a value of 9 specifies the highest priority.


connectionManagement

The connectionManagement object contains information about connection management:

    heartbeatInterval
    Integer.
    Specifies the time, in seconds, between heartbeat flows that are passed from the sending MCA when there are no messages on the transmission queue. This interval gives the receiving MCA the opportunity to quiesce the channel.

    disconnectInterval
    Integer.
    Specifies the maximum number of seconds that the channel waits for messages to be put on a transmission queue before the channel ends.
    A value of zero causes the message channel agent to wait indefinitely.

    keepAliveInterval
    Integer.
    Specifies the value that is passed to the communications stack for KeepAlive timing for the channel.

    localAddress
    An array of JSON objects that can contain the following attributes that define the local communications address of the channel:

      host
      String.
      Specifies the local IP address or host name.
      This value is returned if the local address in the channel definition contains a host name or IP address.

      port
      Integer.
      Specifies the local port number.
      This value is returned if the local address in the channel definition contains a port number.
      This attribute cannot be used to filter results.

      portRange
      JSON object that contains a range of local ports:

        low
        Integer.
        Specifies the start of the port range.

        high
        Integer.
        Specifies the end of the port range.

      Returned if a port range is specified in the local address in the channel definition.
      This attribute cannot be used to filter results.

    If no local address information is available, an empty array is returned.
    If the local address does not conform to the expected syntax, an array containing a single host attribute having the value of the entire local address is returned.

    shortRetry
    JSON object.
    Specifies the maximum number and interval of attempts that are made to establish a connection to the remote machine before the longRetry.count and longRetry.interval are used:

      count
      Integer.
      Specifies the maximum number of attempts to connect to the remote machine.

      interval
      Integer.
      Specifies the interval in seconds between attempts to connect to the remote machine.

    longRetry
    JSON object.
    Specifies the maximum number of attempts and interval of attempts that are made to establish a connection to the remote machine after the count by shortRetry.count is exhausted:

      count
      Integer.
      Specifies the maximum number of attempts to connect to the remote machine.

      interval
      Integer.
      Specifies the interval in seconds between attempts to connect to the remote machine.


compression

The compression object contains attributes that are related to data compression:

    header
    String array.
    Specifies the header data compression techniques that are supported by the channel. The values that are returned are in order of preference.
    The value is one of the following values:

      none
      Specifies that no header data compression is performed.

      system
      Specifies that header data compression is performed.

    message
    String array.
    Specifies the message data compression techniques that are supported by the channel. The values that are returned are in order of preference.
    The value is one of the following values:

      none
      Specifies that no header data compression is performed.

      runLengthEncoding
      Specifies that message data compression is performed by using run-length encoding.

      zlibFast
      Specifies that message data compression is performed by using ZLIB encoding with speed prioritized.

      zlibHigh
      Specifies that message data compression is performed by using ZLIB encoding with compression prioritized.

      any
      Specifies that any compression technique that is supported by the queue manager can be used.
      This value is only valid for channels of type receiver and requester.


dataCollection

The dataCollection object contains attributes that are related to data collection, monitoring, and statistics:

    monitoring
    String.
    Specifies whether online monitoring data is collected, and if so, the rate at which the data is collected.
    The value is one of the following values:

      off
      Specifies that online monitoring data is not collected for the channel.

      asQmgr
      Specifies that the queue inherits the value from the queue manager MONCHL MQSC parameter.

      low
      Specifies that online monitoring data is collected for the channel if the MONCHL MQSC parameter on the queue manager is not set to none. The rate of data collection is low.

      medium
      Specifies that online monitoring data is collected for the channel if the MONCHL MQSC parameter on the queue manager is not set to none. The rate of data collection is moderate.

      high
      Specifies that online monitoring data is collected for the channel if the MONCHL MQSC parameter on the queue manager is not set to none. The rate of data collection is high.

    statistics
    String.
    Specifies whether statistics data is collected for the channel.
    The value is one of the following values:

      off
      Specifies that statistics data is not collected for the channel.

      asQmgr
      Specifies that the channel inherits the value from the queue manager STATCHL MQSC parameter.

      low
      Specifies that statistics data is collected for the channel if the STATCHL MQSC parameter on the channel manager is not set to none. The rate of data collection is low.

      medium
      Specifies that statistics data is collected for the channel if the STATCHL MQSC parameter on the channel manager is not set to none. The rate of data collection is moderate.

      high
      Specifies that statistics data is collected for the channel if the STATCHL MQSC parameter on the channel manager is not set to none. The rate of data collection is high.


exits

The exits object contains information about channel exits:

    message
    An array of JSON objects that contain the following attributes that define the channel message exits:

      name
      String.
      Specifies the message exit name.

      userData
      String.
      Specifies the user data that is passed to the message exit.

    messageRetry
    A JSON object that contains the following attributes that define the channel message retry exit:

      name
      String.
      Specifies the message retry exit name.

      userData
      String.
      Specifies the user data that is passed to the message retry exit.

    receive
    An array of JSON objects that contain the following attributes that define the channel receive exits:

      name
      String.
      Specifies the receive exit name.

      userData
      String.
      Specifies the user data that is passed to the receive exit.

    security
    A JSON object that contains the following attributes that define the channel security exit:

    send
    An array of JSON objects that contain the following attributes that define the channel send exits:

      name
      String.
      Specifies the send exit name.

      userData
      String.
      Specifies the user data that is passed to the send exit.


extended

The extended object contains attributes that are related to extended channel properties, such as data conversion and sequence number settings:

    channelAgentType
    String.
    Specifies the type of the message channel agent program.
    The value is one of the following values:

      process

      thread

    messagePropertyControl
    String.
    Specifies what happens to message properties when the message is about to be sent to a V6 or earlier queue manager, which does not understand the concept of a property descriptor.
    The value is one of the following values:

      compatible
      If the message contains a property with a prefix of mcd., jms., usr. or mqext., all message properties are delivered to the application in an MQRFH2 header. Otherwise, all properties of the message, except those properties that are contained in the message descriptor (or extension), are discarded and are no longer accessible to the application.

      none
      All properties of the message, except those properties in the message descriptor (or extension), are removed from the message before the message is sent to the remote queue manager.

      all
      All properties of the message are included with the message when it is sent to the remote queue manager. The properties, except those properties in the message descriptor (or extension), are placed in one or more MQRFH2 headers in the message data.

    senderDataConversion
    Boolean.
    Specifies whether the sender must convert application data.

    sequenceNumberWrap
    Integer.
    Specifies the maximum message sequence number.
    When the maximum is reached, sequence numbers wrap to start again at 1.

    resetSequenceNumber
    Integer.
    Specifies the pending reset sequence number.
    A nonzero value indicates that a reset channel request is outstanding. The value is in the range 1 - 999999999.

    securityPolicyProtection
    String
    Specifies what happens to messages across the channel when AMS is active and an applicable policy exists.
    This parameter is applicable to Sender, Server, Receiver and Requester channels.
    The value is one of the following:

      passThrough
      Pass through, unchanged, any messages sent or received by the MCA for this channel.
      This value is valid for channels with a channel type of sender, server, receiver, or requester, and is the default value.

    remove
    Remove any AMS protection from messages retrieved from the transmission queue by the MCA, and send the messages to the partner.
    When the message channel agent gets a message from the transmission queue, if an AMS policy is defined for the transmission queue, it is applied to remove any AMS protection from the message prior to sending the message across the channel. If an AMS policy is not defined for the transmission queue, the message is sent as is.
    This value is valid for channels with a channel type of sender or server only.

    asPolicy
    Based on the policy defined for the target queue, apply AMS protection to inbound messages prior to putting them on to the target queue.
    When the message channel agent receives an inbound message, if an AMS policy is defined for the target queue, AMS protection is applied to the message prior to the message being put to the target queue. If an AMS policy is not defined for the target queue, the message is put to the target queue as is.
    This value is valid for channels with a channel type of receiver or requester only.


failedDelivery

The failedDelivery object contains attributes that are related to channel behavior when delivery of a message fails:

    retry
    JSON object.
    Specifies the maximum number of attempts and the interval of attempts that are made to establish a connection to the remote machine before the longRetry.count and longRetry.interval are used:

      count
      Integer.
      Specifies the maximum number of attempts to redeliver the message.

      interval
      Integer.
      Specifies the interval, in milliseconds, between attempts to redeliver the message.

    This attribute is only returned for channels of type receiver, requester, and clusterReceiver.

    useDeadLetterQueue
    Boolean.
    Specifies whether the dead-letter queue is used when messages cannot be delivered by channels:

      false
      Specifies that messages that cannot be delivered by a channel are treated as a failure. The channel either discards the message, or the channel ends, in accordance with the nonPersistentMessageSpeedFast setting.

      true
      Specifies that when the DEADQ attribute of a queue manager provides the name of a dead-letter queue, then the dead letter queue is used. Otherwise, the behavior is as for false.


general

The general object contains attributes that are related to more generic channel properties, such as description:

    description
    String.
    Specifies the description of the channel.

    maximumMessageLength
    Integer.
    Specifies the maximum message length that can be transmitted on the channel. This value is compared with the value for the remote channel, and the actual maximum is the lower of the two values.


batch

The batch object contains attributes that are related to batches of messages that are sent through the channel:

    preCommitHeartbeat
    Integer.
    Specifies whether batch heartbeats are used.
    The value is the length of the heartbeat in milliseconds.

    timeExtend
    Integer.
    Specifies the approximate time, in milliseconds, that a channel keeps a batch open if fewer than batch.messageLimit messages have been transmitted in the current batch.

    dataLimit
    Integer.
    Specifies the limit, in KB, of the amount of data that can be sent through a channel before a sync point is taken.

    messageLimit
    Integer.
    Specifies the maximum number of messages that can be sent through a channel before a sync point is taken.

    nonPersistentMessageSpeedFast
    Boolean.
    Specifies whether fast speed is used to send nonpersistent messages.
    Fast speed means that nonpersistent messages on a channel need not wait for a syncpoint before the messages are made available for retrieval.


queueSharingGroup

The queueSharingGroup object contains attributes that are related to queue sharing groups on z/OS :

    disposition
    String.
    This attribute is only available on z/OS.
    Specifies the disposition of the channel. That is, where it is defined and how it behaves.
    This value is always returned if the queue manager is a member of the queue sharing group.
    The value is one of the following values:

      qmgr
      Specifies that the channel definition exists on the page set of the queue manager that runs the command.

      group
      Specifies that the channel definition exists in the shared repository.

      copy
      Specifies that the channel definition exists on the page set of the queue manager that runs the command, copying its definition from the channel of the same name defined in the shared repository.

    This attribute cannot be used to filter results.

    defaultChannelDisposition
    String.
    This attribute is only available on z/OS.
    Specifies the intended disposition of a channel when it is activated or started.
    The value is one of the following values:

      private
      Specifies that the intended use of the object is as a private channel.

      fixShared
      Specifies that the intended use of the object is as a fixshared channel.

      shared
      Specifies that the intended use of the object is as a shared channel.


receiverSecurity

The receiverSecurity object contains attributes that are related to security for receiving channels:

    channelAgentUserId
    String.
    Specifies the user identifier that is to be used by the message channel agent for authorization to access IBM MQ resources, including authorization to put the message to the destination queue for receiver or requester channels.
    If the value is blank, the message channel agent uses its default user identifier.

    putAuthority
    String.
    Specifies which user identifiers are used to establish authority to put messages to the destination queue.
    The value is one of the following values:

      default
      Specifies that the default user identifier is used.

      context
      Specifies that the user ID from the UserIdentifier field of the message descriptor is used.

      alternateOrChannelAgent
      Specifies that the user ID from the UserIdentifier field of the message descriptor is used.
      This value is only supported on z/OS.

      onlyChannelAgent
      Specifies that the user ID derived from MCAUSER is used.


transmissionSecurity

The transmissionSecurity object contains attributes that are related to security for message transmission:

    certificateLabel
    String.
    Specifies which personal certificate in the key repository is sent to the remote peer.
    If this attribute is blank, the certificate is determined by the queue manager CERTLABL parameter.

    cipherSpecification
    String.
    Specifies the name of the cipher that the channel uses.

    requirePartnerCertificate
    Boolean.
    Specifies whether IBM MQ requires a certificate from the TLS client.

    certificatePeerName
    String.
    Specifies the filter to use to compare with the Distinguished Name of the certificate from the peer queue manager or client at the other end of the channel. A Distinguished Name is the identifier of the TLS certificate.


currentStatus

The currentStatus object contains attributes that are related to current status information:

    inDoubt
    Boolean.
    Specifies whether the channel is in doubt.
    A sending channel is in doubt only while the sending message channel agent is waiting for an acknowledgment that a batch of sent messages has been successfully received.

    state
    String.
    Specifies the current status of the channel.
    The value is one of the following values:

      binding
      Specifies that the channel is negotiating with the partner.

      starting
      Specifies that the channel is waiting to become active.

      running
      Specifies that the channel is transferring or waiting for messages.

      paused
      Specifies that the channel is paused.

      stopping
      Specifies that the channel is in process of stopping.

      retrying
      Specifies that the channel is reattempting to establish connection.

      stopped
      Specifies that the channel is stopped.

      requesting
      Specifies that the requester channel is requesting connection.

      switching
      Specifies that the channel is switching transmission queues.

      initializing
      Specifies that the channel is initializing.

    agent
    A JSON object that contains attributes that are related to the message channel agent:

      jobName
      String.
      Specifies the name of the MCA job.

      running
      Boolean.
      Specifies whether the MCA is running or not.

      state
      String.
      Specifies the current action being performed by the MCA.
      The value is one of the following values:

        runningChannelAutoDefinitionExit
        Specifies that the MCA is running a channel auto-definition exit.

        compressingData
        Specifies that the MCA is compressing or decompressing data.

        processingEndOfBatch
        Specifies that the MCA is performing end of batch processing.

        performingSecurityHandshake
        Specifies that the MCA is performing TLS handshaking.

        heartbeating
        Specifies that the MCA is heartbeating with a partner.

        executingMQGET
        Specifies that the MCA is performing an MQGET.

        executingMQI
        Specifies that the MCA is executing an IBM MQ API call, other than an MQPUT or MQGET.

        executingMQPUT
        Specifies that the MCA is performing an MQPUT.

        runningRetryExit
        Specifies that the MCA is running a retry exit.

        runningMessageExit
        Specifies that the MCA is running a message exit.

        communicatingWithNameServer
        Specifies that the MCA is processing a name server request.

        connectingToNetwork
        Specifies that the MCA is connecting to the network.

        undefined
        Specifies that the MCA is in an undefined state.

        runningReceiveExit
        Specifies that the MCA is running a receive exit.

        receivingFromNetwork
        Specifies that the MCA is receiving from the network.

        resynchingWithPartner
        Specifies that the MCA is resynching with a partner.

        runningSecurityExit
        Specifies that the MCA is running a security exit.

        runningSendExit
        Specifies that the MCA is running a send exit.

        sendingToNetwork
        Specifies that the MCA is performing a network send.

        serializingAccessToQmgr
        Specifies that the MCA is serialized on queue manager access.

      userId
      Specifies the user ID that is in use by the MCA.
      This attribute is only applicable to receiver, requester, and cluster receiver channels.

    batch
    JSON Object containing attributes that are related to batches of messages:

      count
      Integer.
      Specifies the number of completed batches.

      currentMessages
      Integer.
      Specifies the number of messages that are sent or received in the current batch.
      When a sending channel becomes in-doubt, it specifies the number of the messages that are in-doubt.
      The number is reset to 0 when the batch is committed.

      luwid
      JSON object that contains attributes that are related to logical units of work:

        current
        String.
        This identifier is represented as 2 hexadecimal digits for each byte.
        Specifies the logical unit of work identifier that is associated with the current batch.
        For a sending channel, when the channel is in-doubt it is the LUWID of the in-doubt batch.

        last
        String.
        This identifier is represented as 2 hexadecimal digits for each byte.
        Specifies the logical unit of work identifier that is associated with the last committed batch.

      nonPersistentMessageSpeedFast
      Boolean.
      Specifies whether non-persistent messages are to be sent at fast speed.

      sequenceNumber
      JSON object that contains attributes that are related to sequence numbers:

        current
        Integer.
        Specifies the message sequence number of the last message sent or received.
        When a sending channel becomes in-doubt, it is the message sequence number of the last message in the in-doubt batch.

        last
        Integer.
        Specifies the sequence number of last message in last committed batch.

      size
      Integer.
      Specifies the negotiated batch size.

    compression
    JSON Object that contains attributes that are related to data compression:

      header
      JSON object that contains attributes that are related to header data compression:

        default
        String.
        Specifies the default header data compression value that is negotiated for this channel.
        The value is one of the following values:

          none
          Specifies that no header data compression is performed.

          system
          Specifies that header data compression is performed.

        lastMessage
        String.
        Specifies the header data compression value that was used for the last message sent.
        The value is one of the following values:

          none
          Specifies that no header data compression was performed.

          system
          Specifies that header data compression was performed.

          unavailable
          Specifies that no message was sent.

      message
      JSON object that contains attributes that are related to message data compression:

        default
        String.
        Specifies the default message data compression value that was negotiated for this channel.
        The value is one of the following values:

          none
          Specifies that no message data compression is performed.

          runLengthEncoding
          Specifies that message data compression is performed by using run-length encoding.

          zlibFast
          Specifies that message data compression is performed by using ZLIB encoding with speed prioritized.

          zlibHigh
          Specifies that message data compression is performed by using ZLIB encoding with compression prioritized.

        lastMessage
        String.
        Specifies the message data compression value that was used for the last message sent.
        The value is one of the following values:

          none
          Specifies that no message data compression was performed.

          runLengthEncoding
          Specifies that message data compression was performed by using run-length encoding.

          zlibFast
          Specifies that message data compression was performed by using ZLIB encoding with speed prioritized.

          zlibHigh
          Specifies that message data compression was performed by using ZLIB encoding with compression prioritized.

          unavailable
          Specifies that no message was sent.

    connectionManagement
    JSON Object that contains attributes that are related to connection management:

      heartbeatInterval
      Integer.
      Specifies the heartbeat interval in seconds.

      keepAliveInterval
      Integer.
      Specifies the value that is passed to the communications stack for KeepAlive timing for the channel.
      This parameter is only available on the z/OS

      localAddress
      An array of JSON objects that can contain the following attributes that define the local communications address of the channel:

        host
        String.
        Specifies the IP address or host name that is used for local communications.

        port
        Integer.
        Specifies the port number that is used for local communications.
        This attribute cannot be used to filter results.

      If no local address information is available, an empty array is returned.

      remainingRetries
      JSON object that contains attributes that are related to connection retry attempts:

        long
        Integer.
        Specifies the number of long retry attempts remaining.

        last
        Integer.
        Specifies the number of short retry attempts remaining.

      This object is applicable only to sender, server, and cluster-sender channels.

    extended
    JSON object that contains attributes that are related to extended channel status properties:

      buffers
      JSON object that contains the following attributes that are related to buffers:

        received
        Integer.
        Specifies the number of buffers received.

        sent
        Integer.
        Specifies the number of buffers sent.

      bytes
      JSON object that contains the following attributes that are related to data transmission:

        received
        Integer.
        Specifies the number of bytes received.

        sent
        Integer.
        Specifies the number of bytes sent.

      messageCount
      Integer.
      Specifies the total number of messages that are sent or received, or the number of MQI calls handled.

    general
    JSON Object containing more generic attributes that are related to channels:

      heartbeatInterval
      Integer.
      Specifies the heartbeat interval in seconds.

      keepAliveInterval
      Integer.
      Specifies the value that is passed to the communications stack for KeepAlive timing for the channel.
      This parameter is only available on the z/OS

      connection
      An array of JSON objects that can contain the following attributes that define the remote communications address of the channel:

        host
        String.
        Specifies the remote IP address or host name.

        port
        Integer.
        Specifies the remote port number.
        This attribute cannot be used to filter results.

      If no connection information is available, an empty array is returned.
      If the connection does not conform to the expected syntax, an array containing a single host attribute having the value of the entire connection is returned.

      maximumMessageLength
      Integer.
      Specifies the maximum length of a message.

      statistics
      String.
      Specifies the rate at which statistics data is collected for the channel.
      The value is one of the following values:

        off
        Specifies that no data is collected.

        low
        Specifies a low rate of data collection.

        medium
        Specifies a medium rate of data collection.

        high
        Specifies a high rate of data collection.

      stopRequested
      Boolean.
      Specifies whether a stop request from the user has been received.

      transmissionQueueName
      String.
      Specifies the name of the transmission queue in use by the channel.

    monitoring
    JSON object that contains more generic attributes that are related to channel monitoring:

      messagesInBatch
      JSON object that contains information about the number of messages in a batch:

        shortSamplePeriod
        Specifies the number of messages in a batch, based on recent activity over a short period.

        longSamplePeriod
        Specifies the number of messages in a batch, based on activity over a long period.

      rate
      String.
      Specifies the rate at which monitoring data is collected for the channel.
      The value is one of the following values:

        off
        Specifies that no data is collected.

        low
        Specifies a low rate of data collection.

        medium
        Specifies a medium rate of data collection.

        high
        Specifies a high rate of data collection.

      compressionRate
      JSON object that contains information about data compression rates:

        shortSamplePeriod
        Specifies the compression rate as a percentage, based on recent activity over a short period.
        If no measurement is available, a value of -1 is returned.

        longSamplePeriod
        Specifies the compression rate as a percentage, based on activity over a long period.
        If no measurement is available, a value of -1 is returned.

      compressionTime
      JSON object that contains information about data compression rates:

        shortSamplePeriod
        Specifies the compression speed as the time in microseconds spent compressing or decompressing each message, based on recent activity over a short period.
        If no measurement is available, a value of -1 is returned.

        longSamplePeriod
        Specifies the compression speed as the time in microseconds spent compressing or decompressing each message, based on activity over a long period.
        If no measurement is available, a value of -1 is returned.

      exitTime
      JSON object that contains information about exit processing speed:

        shortSamplePeriod
        Specifies the exit processing speed as the time in microseconds spent processing user exits for each message, based on recent activity over a short period.
        If no measurement is available, a value of -1 is returned.

        longSamplePeriod
        Specifies the exit processing speed as the time in microseconds spent processing user exits for each message, based on activity over a long period.
        If no measurement is available, a value of -1 is returned.

      messagesAvailable
      Integer.
      Specifies the number of messages currently queued on the transmission queue and available for MQGETs.

      networkTime
      JSON object that contains information about network performance:

        shortSamplePeriod
        Specifies the time, in microseconds, to send a request to the remote end of the channel and receive a response, based on recent activity over a short period.
        If no measurement is available, a value of -1 is returned.

        longSamplePeriod
        Specifies the time, in microseconds, to send a request to the remote end of the channel and receive a response, based on activity over a long period.
        If no measurement is available, a value of -1 is returned.

      transmissionQueueTime
      JSON object that contains information about transmission queue delay:

        shortSamplePeriod
        Specifies the time, in microseconds, that messages remain on the transmission queue before being retrieved, based on recent activity over a short period.
        If no measurement is available, a value of -1 is returned.

        longSamplePeriod
        Specifies the time, in microseconds, that messages remain on the transmission queue before being retrieved, based on activity over a long period.
        If no measurement is available, a value of -1 is returned.

      This attribute is only applicable to sender, server, and cluster sender channels.

    partner
    JSON Object that contains attributes that are related to the remote end queue manager:

      productIdentifier
      String.
      Specifies the product identifier for the IBM MQ version that is running at the remote end of the channel.
      The value is one of the following values:

        MQMM
        Queue Manager (non z/OS Platform)

        MQMV
        Queue Manager on z/OS

        MQCC
        IBM MQ C client

        MQNM
        IBM MQ .NET fully managed client

        MQJB
        IBM MQ Classes for Java

        MQJM
        IBM MQ Classes for JMS (normal mode)

        MQJN
        IBM MQ Classes for JMS (migration mode)

        MQJU
        Common Java interface to the MQI

        MQXC
        XMS client C/C++ (normal mode)

        MQXD
        XMS client C/C++ (migration mode)

        MQXN
        XMS client .NET (normal mode)

        MQXM
        XMS client .NET (migration mode)

        MQXU
        IBM MQ .NET XMS client (unmanaged/XA)

        MQNU
        IBM MQ .NET unmanaged client

      qmgrName
      String.
      Specifies the name of the remote queue manager or queue sharing group.

      version
      String.
      Specifies the version of IBM MQ running at the remote end of the channel, in the form V.R.M.F.

      maximumMessageLength
      Integer.
      Specifies the maximum length of a message.

    queueSharingGroup
    JSON Object that contains attributes that are related to the queue sharing group this channel belongs to:

      channelDisposition
      String.
      This attribute is only available on z/OS.
      Specifies the disposition of the channel. That is, where it is defined and how it behaves.
      The value is one of the following values:

        qmgr
        Specifies that the channel definition exists on the page set of the queue manager that runs the command.

        group
        Specifies that the channel definition exists in the shared repository.

        copy
        Specifies that the channel definition exists on the page set of the queue manager that runs the command, copying its definition from the channel of the same name defined in the shared repository.

    timestamps
    JSON object that contains attributes that are related to date and time information:

      started
      String.
      Specifies the date and time at which the channel was started.
      For more information about the time stamp format that is used to return the date and time, see REST API time stamps.

      lastMessage
      String.
      Specifies the date and time at which the last message was sent over the channel.
      For more information about the time stamp format that is used to return the date and time, see REST API time stamps.

    transmissionSecurity
    JSON object that contains attributes that are related to transmission security:

      certificateIssuerName
      String.
      Specifies the full Distinguished Name of the issuer of the remote certificate.

      certificateUserId
      String.
      Specifies the local user ID that is associated with the remote certificate.

      cipherSpecification
      String.
      Specifies the name of the cipher that the channel uses.

      keyLastReset
      String.
      Specifies the date and time of the last successful TLS secret key reset.
      For more information about the time stamp format that is used to return the date and time, see REST API time stamps.

      keyResetCount
      String.
      Specifies the number of successful TLS secret key resets since the channel started.

      protocol
      String.
      This parameter is available on UNIX, Linux, and Windows platforms and on the IBM MQ Appliance.
      From IBM MQ Version 9.1.1, this parameter is also available on z/OS.
      Specifies the security protocol currently in use.
      The value is one of the following values:

        none
        Specifies that no security protocol is in use.

        sslV30
        Specifies that SSL 3.0 is in use.

        tlsV10
        Specifies that TLS 1.0 is in use.

        tlsV12
        Specifies that TLS 1.2 is in use.

      shortPeerName
      String.
      Specifies the Distinguished Name of the peer queue manager or client at the other end of the channel.


savedStatus

The savedStatus object contains attributes that are related to saved status information:

    inDoubt
    Boolean.
    Specifies whether the channel was in doubt.
    A sending channel is only in doubt while the sending message channel agent is waiting for an acknowledgment that a batch of messages, which it has sent, has been successfully received.

    batch
    JSON Object that contains attributes that are related to batches of messages:

      currentMessages
      Integer.
      Specifies the number of messages that are sent or received in the current batch or, if the channel was in-doubt, the number of messages that were in-doubt.
      In the context of saved status, this number is only meaningful if the channel was in-doubt, but this value is returned regardless.

      luwid
      JSON object that contains attributes that are related to logical units of work:

        current
        String. This identifier is represented as 2 hexadecimal digits for each byte.
        Specifies the logical unit of work identifier that is associated with the current batch.
        For a sending channel, if the channel was in-doubt, it specifies the LUWID of the in-doubt batch.
        In the context of saved status, this number is only meaningful if the channel was in-doubt, but this value is returned regardless.

        last
        Hex string.
        Specifies the logical unit of work identifier that is associated with the last committed batch.

      sequenceNumber
      JSON object that contains attributes that are related to sequence numbers:

        current
        Integer.
        Specifies the message sequence number of the last message that is sent or received.
        When a sending channel is in-doubt, it specifies the sequence number of the last message in the in-doubt batch.

        last
        Integer.
        Specifies the sequence number of the last message in the last committed batch.

    general
    JSON Object that contains more generic attributes that are related to channels:

      connection
      An array of JSON objects that can contain the following attributes that define the remote communications address of the channel:

        host
        String.
        Specifies the remote IP address or host name.

        port
        Integer.
        Specifies the remote port number.
        This attribute cannot be used to filter results.

      If no connection information is available, an empty array is returned.
      If the connection does not conform to the expected syntax, an array containing a single host attribute having the value of the entire connection is returned.

      transmissionQueueName
      String.
      Specifies the name of the transmission queue in use by the channel.

    queueSharingGroup
    JSON Object that contains attributes that are related to the queue sharing group this channel belonged to:

      channelDisposition
      String.
      This attribute is only available on z/OS.
      Specifies the disposition of the channel. That is, where it was defined and how it behaved.
      The value is one of the following values:

        qmgr
        Specifies that the channel definition existed on the page set of the queue manager that runs the command.

        group
        Specifies that the channel definition existed in the shared repository.

        copy
        Specifies that the channel definition existed on the page set of the queue manager that runs the command, copying its definition from the channel of the same name defined in the shared repository.

Parent topic: GET

Last updated: 2020-10-04