Get the status of the queue manager - curl

Get the status of the queue manager instance.

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

Request

Custom Headers

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`

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

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`

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}/status"

Response

Response Body QueueManagerStatus	QueueManagerStatus
`status` Always included* string	The deploying and failed states are not queue manager states, they are states which can occur when the request to deploy has been fired, or with that request has failed without producing a queue manager to have any state. The other states map to the queue manager states. State "ending" is either `quiesing` or ending immediately. State "ended" is either ended normally or `endedimmediately`. The others map one to one with queue manager states. Possible values: [`initializing`,`deploying`,`starting`,`running`,`stopping`, `stopped`,`status_not_available`,`deleting`,`failed`,`upgrading_version`, `updating_revision`,`initialization_failed`,`restoring_queue_manager`,`restoring_config`,`restore_failed`, `suspended`,`resumable`]

Response Body

QueueManagerStatus

status

Always included*
string

The deploying and failed states are not queue manager states, they are states which can occur when the request to deploy has been fired, or with that request has failed without producing a queue manager to have any state. The other states map to the queue manager states. State "ending" is either quiesing or ending immediately. State "ended" is either ended normally or endedimmediately. The others map one to one with queue manager states.

Possible values: [initializing,deploying,starting,running,stopping,

stopped,status_not_available,deleting,failed,upgrading_version,

updating_revision,initialization_failed,restoring_queue_manager,restoring_config,restore_failed,

suspended,resumable]

Status code
200	Current status for the queue manager
301	URI has permanently Moved
400	Bad Request
401	Unauthorized
404	Resource not found
429	Service Is Overused
500	Internal Server Error

Example response

Success 200

{
  "status": "running"
}