reserved instance

Get connection information for a queue manager - curl

Get connection information for a queue manager.

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

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

Response

Response Body
ConnectionInfo
 Responds with JSON CCDT of the connection information for the queue manager
channel
Always included*

A collection of channel connection details.

Possible values: 0 ≤ number of items ≤ 999999999
 
  • name
    Always included*
    string

    Specifies the name of the channel.

  • clientConnection
    Always included*

    Details for a client connection.

    • connection

      A collection of objects with attributes that define a channel connection.

      Possible values: 0 ≤ number of items ≤ 999999999

      • host
        string

        Specifies the host that this channel connects to.

      • port
        integer

        Specifies the port that this channel uses on this host.

    • queueManager
      string
      The name of the queue_manager
  • transmissionSecurity
    Always included*

    An object that contains attributes that are related to security for message transmission.

    • cipherSpecification
      string
      Specifies the name of the CipherSpec for the channel to use.
  • type
    Always included*
    string
    Specifies the type of the channel.
Status code  
200 Response of the connection information 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

{
  "channel": [
    {
      "name": "CLOUD.ADMIN.SVRCONN",
      "clientConnection": {
        "connection": [
          {
            "host": "myqm-fre.qm1.eu-de.mq2.cloud.ibm.com",
            "port": 30446
          }
        ],
        "queueManager": "myqm"
      },
      "transmissionSecurity": {
        "cipherSpecification": "ANY_TLS12_OR_HIGHER"
      },
      "type": "clientConnection"
    }
  ]
}