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 is created.
PUT |
|
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 |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"name": "name of a queue manager",
"clusters": [
"name of a cluster this queue manager is part of",
"another name of a cluster this queue manager is part of"
],
"aliasQueues": [
{
"aliasQueue": "alias queue name",
"baseQueue": "real queue name",
"clusterVisibility": [
"name of a cluster this alias should be visible in",
"another cluster"
]
}
],
"remoteQueues": [
{
"localQueue": "local definition of the remote queue",
"remoteQueue": "remote queue name",
"remoteQueueManager": "remote queue manager name",
"clusterVisibility": [
"name of a cluster this local definition of the remote queue should be visible in",
"another cluster"
]
}
],
"clusterQueues": [
{
"localQueue": "name of a local queue",
"clusterVisibility": [
"name of a cluster this local queue should be visible in",
"another cluster"
]
}
]
}
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 DESK entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the DESK entity. |
name | string | The name of the DESK entity. |
description | string | A short description of the DESK entity. |
{}
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
POST |
|
Response codes
Code | Description |
---|---|
204 | Validated. The submitted configuration is valid. Response does not have a body. |
400 | Failed. The input is invalid. See the response body for details. |