reserved instance

Get details of a queue manager - curl

Get the details of a given queue manager.

GET /v1/{service_instance_guid}/queue_managers/{queue_manager_id}

Request

Custom Headers  
Accept-Language
string

The acceptable list of languages supported in the client.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression [a-zA-Z0-9\-;,\s.]*

Example: en-US,en;q=0.5
Path Parameters  
service_instance_guid
Required*
string

The GUID that uniquely identifies the IBM® MQ as a Service instance.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example: a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
queue_manager_id
Required*
string

The id of the queue manager to retrieve its full details.

Possible values: length = 32, Value must match regular expression ^[0-9a-fA-F]{32}$

Example: b8e1aeda078009cf3db74e90d5d42328

Example request

curl -X GET --location --header "Authorization: Bearer ${iam_token}" --header "Accept: application/json" "${base_url}/v1/${service_instance_guid}/queue_managers/${queue_manager_id}"

Response

Response BodyQueueManagerCollection The details of the queue manager
id
Always included*
string

The ID of the queue manager which was allocated on creation, and can be used for delete calls.
name
Always included*
string

A queue manager name conforming to MQ restrictions.

Possible values: 1 ≤ length ≤ 48, Value must match regular expression ^[a-zA-Z0-9._]*$
display_name
Always included*
string

A displayable name for the queue manager - limited only in length.

Possible values: length ≤ 150
location
Always included*
string

The locations in which the queue manager could be deployed.

Possible values: 2 ≤ length ≤ 150, Value must match regular expression ^([^[:ascii:]]|[a-zA-Z0-9-._: ])+$

Example: reserved-eu-de-cluster-f884
size
Always included*
string

The queue manager sizes of deployment available.

Possible values: [xsmall,small,medium,large]

Example: small
status_uri
Always included*
string

A reference uri to get deployment status of the queue manager.
version
Always included*
string

The MQ version of the queue manager.

Possible values: 7 ≤ length ≤ 15, Value must match regular expression ^[0-9]+.[0-9]+.[0-9]+_[0-9]+$

Example: 9.3.2_2
web_console_url
Always included*
string

The url through which to access the web console for this queue manager.
rest_api_endpoint_url
Always included*
string

The url through which to access REST APIs for this queue manager.
administrator_api_endpoint_url
Always included*
string

The url through which to access the Admin REST APIs for this queue manager.
connection_info_uri
Always included*
string

The uri through which the CDDT for this queue manager can be obtained.
date_created
Always included*
date-time

RFC3339 formatted UTC date for when the queue manager was created.

Example: 2020-01-13T15:39:35.000Z
upgrade_available
Always included*
boolean

Describes whether an upgrade is available for this queue manager.

Example: true
available_upgrade_versions_uri
Always included*
string

The uri through which the available versions to upgrade to can be found for this queue manager.
href
Always included*
string

The URL for this queue manager.
Status code  
200 Description of the queue manager
301 URI has permanently Moved
400 Bad Request
401 Unauthorized
404 Resource not foud
429 Service Is Overused
500 Internal Server Error

Example response

Success 200

{
  "id": "b8e1aeda078009cf3db74e90d5d42328",
  "name": "testqm",
  "display_name": "Test QM",
  "location": "ibmcloud_us_south",
  "size": "xsmall",
  "status_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/status",
  "version": "9.3.2_2",
  "web_console_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/console",
  "rest_api_endpoint_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/rest/v3/messaging/qmgr/testqm/queues/<queue_name>/message",
  "administrator_api_endpoint_url": "https://web-testqm-fc4f.qm1.eu-de.mq.appdomain.cloud/ibmmq/rest/v3/admin/qmgr/testqm",
  "connection_info_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/connection_info",
  "date_created": "2023-07-19T14:46:05Z",
  "upgrade_available": false,
  "available_upgrade_versions_uri": "/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328/available_versions",
  "href": "https://api.private.eu-de.mq2.cloud.ibm.com/v1/a2b4d4bc-dadb-4637-bcec-9b7d1e723af8/queue_managers/b8e1aeda078009cf3db74e90d5d42328"
}