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.
- port
- Integer.
- transmissionQueueName
- String.
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.
- port
- Integer.
- transmissionQueueName
- String.
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.
- port
- Integer.
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.
- port
- Integer.
- clusterName
- String.
- clusterNamelist
- String.
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.
- port
- Integer.
- clusterName
- String.
- clusterNamelist
- String.
clusterRouting
The
clusterRouting
object contains information about routing within clusters
and is returned only for cluster receiver and cluster sender channels:- workloadPriority
- Integer.
- workloadRank
- Integer.
- workloadWeight
- Integer.
- networkPriority
- Integer.
connectionManagement
The
connectionManagement
object contains information about connection management:- heartbeatInterval
- Integer.
- disconnectInterval
- Integer.
- keepAliveInterval
- Integer.
- localAddress
- An array of JSON objects that can contain the following attributes that define the local
communications address of the channel:
- host
- String.
- port
- Integer.
- portRange
- JSON object that contains a range of local ports:
- low
- Integer.
- high
- Integer.
- shortRetry
- JSON object.
- longRetry
- JSON object.
compression
The
compression
object contains attributes that are related to data compression:- header
- String array.
- message
- String array.
dataCollection
The
dataCollection
object contains attributes that are related to data
collection, monitoring, and statistics: - monitoring
- String.
- statistics
- String.
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.
- userData
- String.
- messageRetry
- A JSON object that contains the following attributes that define the channel message retry exit:
- name
- String.
- userData
- String.
- receive
- An array of JSON objects that contain the following attributes that define the channel
receive exits:
- name
- String.
- userData
- String.
- security
- A JSON object that contains the following attributes that define the channel security exit:
- name
- String.
- userData
- String.
- send
- An array of JSON objects that contain the following attributes that define the channel send exits:
- name
- String.
- userData
- String.
extended
The
extended
object contains attributes that are related to extended channel
properties, such as data conversion and sequence number settings:- channelAgentType
- String.
- messagePropertyControl
- String.
- senderDataConversion
- Boolean.
- sequenceNumberWrap
- Integer.
- resetSequenceNumber
- Integer.
failedDelivery
The
failedDelivery
object contains attributes that are related to channel behavior when delivery of
a message fails:- retry
- JSON object.
- useDeadLetterQueue
- Boolean.
general
The
general
object contains attributes that are related to more generic channel
properties, such as description:- description
- String.
- maximumMessageLength
- Integer.
batch
The
batch
object contains attributes that are related to batches of messages
that are sent through the channel:- preCommitHeartbeat
- Integer.
- timeExtend
- Integer.
- dataLimit
- Integer.
- messageLimit
- Integer.
- nonPersistentMessageSpeedFast
- Boolean.
queueSharingGroup
The
queueSharingGroup
object contains attributes that are related to queue
sharing groups on z/OS®:- disposition
- String.
- defaultChannelDisposition
- String.
receiverSecurity
The
receiverSecurity
object contains attributes that are related to security for receiving channels:- channelAgentUserId
- String.
- putAuthority
- String.
transmissionSecurity
The
transmissionSecurity
object contains attributes that are related to security for message transmission:- certificateLabel
- String.
- cipherSpecification
- String.
- requirePartnerCertificate
- Boolean.
- certificatePeerName
- String.
currentStatus
The
currentStatus
object contains attributes that are related to current status information:- inDoubt
- Boolean.
- state
- String.
- agent
- A JSON object that contains attributes that are related to the message channel agent:
- jobName
- String.
- running
- Boolean.
- state
- String.
- userId
- Specifies the user ID that is in use by the MCA.
- batch
- JSON Object containing attributes that are related to batches of messages:
- count
- Integer.
- currentMessages
- Integer.
- luwid
- JSON object that contains attributes that are related to logical units of work:
- current
- Hex string.
- last
- String. This identifier is represented as 2 hexadecimal digits for each byte.
- nonPersistentMessageSpeedFast
- Boolean.
- sequenceNumber
- JSON object that contains attributes that are related to sequence numbers:
- current
- Integer.
- last
- Integer.
- size
- Integer.
- 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.
- lastMessage
- String.
- message
- JSON object that contains attributes that are related to message data compression:
- default
- String.
- lastMessage
- String.
- connectionManagement
- JSON Object that contains attributes that are related to connection management:
- heartbeatInterval
- Integer.
- keepAliveInterval
- Integer.
- localAddress
- An array of JSON objects that can contain the following attributes that define the local
communications address of the channel:
- host
- String.
- port
- Integer.
- remainingRetries
- JSON object that contains attributes that are related to connection retry attempts:
- long
- Integer.
- last
- Integer.
- 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.
- sent
- Integer.
- bytes
- JSON object that contains the following attributes that are related to data transmission:
- received
- Integer.
- sent
- Integer.
- messageCount
- Integer.
- general
- JSON Object containing more generic attributes that are related to channels:
- heartbeatInterval
- Integer.
- keepAliveInterval
- Integer.
- connection
- An array of JSON objects that can contain the following attributes that define the remote
communications address of the channel:
- host
- String.
- port
- Integer.
- maximumMessageLength
- Integer.
- statistics
- String.
- stopRequested
- Boolean.
- transmissionQueueName
- String.
- 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.
- 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.
- longSamplePeriod
- Specifies the compression rate as a percentage, based on activity over a long period.
- 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.
- longSamplePeriod
- Specifies the compression speed as the time in microseconds spent compressing or decompressing each message, based on activity over a long period.
- 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.
- 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.
- messagesAvailable
- Integer.
- 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.
- 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.
- 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.
- longSamplePeriod
- Specifies the time, in microseconds, that messages remain on the transmission queue before being retrieved, based on activity over a long period.
- partner
- JSON Object that contains attributes that are related to the remote end queue manager:
- productIdentifier
- String.
- qmgrName
- String.
- version
- String.
- maximumMessageLength
- Integer.
- queueSharingGroup
- JSON Object that contains attributes that are related to the queue sharing group this
channel belongs to:
- channelDisposition
- String.
- timestamps
- JSON object that contains attributes that are related to date and time information:
- started
- String.
- lastMessage
- String.
- transmissionSecurity
- JSON object that contains attributes that are related to transmission security:
- certificateIssuerName
- String.
- certificateUserId
- String.
- keyLastReset
- String.
- keyResetCount
- String.
- protocol
- String.
- shortPeerName
- String.
savedStatus
The
savedStatus
object contains attributes that are related to saved status information:- inDoubt
- Boolean.
- batch
- JSON Object that contains attributes that are related to batches of messages:
- currentMessages
- Integer.
- 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.
- last
- Hex string.
- sequenceNumber
- JSON object that contains attributes that are related to sequence numbers:
- current
- Integer.
- last
- Integer.
- 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.
- port
- Integer.
- transmissionQueueName
- String.
- queueSharingGroup
- JSON Object that contains attributes that are related to the queue sharing group this
channel belonged to:
- channelDisposition
- String.