REST API for Oracle Messaging Cloud Service

Get Listener Properties

get

/listeners/{listenerName}

Retrieve properties of the listener with the supplied name.

Request

Path Parameters

listenerName: string

The name of listener whose properties to retrieve.

Response

Supported Media Types

application/xml

200 Response

The definition of the specified listener was output in the XML format used to create the listener. See the examples in 'Create a Listener' for details.

404 Response

The specified listener does not exist.

500 Response

The listener definition was not retrieved. A low-level exception was thrown while retrieving the listener definition.

Examples

cURL Command

cookie=/tmp/messaging-cookie
curl -s -u $USER:$PASS -c $cookie -b $cookie \
     -H "X-OC-ID-TOKEN-STATUS: disabled" \
     -X GET "https://messaging.us2.oraclecloud.com/myService-myTenant/api/v1/listeners/myFirstListener"

There is no request body to submit with the HTTP request.

Example of Response Body

<listener>
  <version>1.0</version>
  <name>myFirstListener</name>
  <source>
    <type>queue</type>
    <name>myMPLQueue1</name>
  </source>
  <target>
    <uri>urn:oracle:cloud:messaging:queues:myMPLQueue2</uri>
  </target>
</listener>