IBM MQ tracing API - PUT a queue manager

Updates the specified queue manager. If the queue manager with the specified ID doesn’t exist, a new queue manager will be created.

This request is in beta and may be changed in non compatible way.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/ibmMQTracing/queueManager/{name}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/ibmMQTracing/queueManager/{name}

Parameters

Parameter Type Description In Required
name string

The name of the queue manager to be updated.

The name of the queue manager in the body of the request must match this name.

path required
body QueueManager

The JSON body of the request containing updated parameters of the queue manager.

body optional

The QueueManager object

Parameters of the queue manager.

Element Type Description Required
name string

The name of the queue manager.

required
clusters string[]

The queue manager will have access to all cluster visible queues in these clusters.

required
aliasQueues AliasQueue[]

The list of alias queues in the queue manager.

required
remoteQueues RemoteQueue[]

The list of remote queues in the queue manager.

required
clusterQueues ClusterQueue[]

The list of cluster queues in the queue manager.

required

The ClusterQueue object

This local queue is visible in these clusters. The queue manager must be part of these clusters.

Element Type Description Required
localQueue string

The name of the local queue.

required
clusterVisibility string[]

The local queue is visible in these clusters. The queue manager must be part of these clusters.

required

The RemoteQueue object

Define a local definition of a remote queue owned by another queue manager. The local definition can be made visible in one or more clusters.

Element Type Description Required
localQueue string

The name of the local definition of the remote queue.

required
remoteQueue string

The name of the remote queue.

required
remoteQueueManager string

The name of the remote queue manager.

required
clusterVisibility string[]

The local definition of the remote queue is visible in these clusters. The queue manager must be part of these clusters.

required

The AliasQueue object

Define an alias for a so called base queue. This can either be a local queue owned by this queue manager, a local definition of a remote queue or a cluster queue visible but owned by another queue manager. The alias can be made visible in one or more clusters.

Element Type Description Required
aliasQueue string

The name of the alias queue.

required
baseQueue string

The name of the base queue, which the alias queue should point to.

required
clusterVisibility string[]

The alias queue is visible in these clusters. The queue manager must be part of these clusters.

required

Response codes

Code Description
201 Success. The new queue manager has been created. Response contains the name of the queue manager.
204 Success. The queue manager has been updated. Response doesn't have a body.
400 Failed. The input is invalid. See the response body for details.

Response format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Validate payload

We recommend to validate the payload before submitting it with an actual request. The response code of 204 indicated the valid payload.

This request is in beta and may be changed in non compatible way.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/ibmMQTracing/queueManager/{name}/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/ibmMQTracing/queueManager/{name}/validator