Jump to

• Request
• Response
• Examples

Get Queue Properties

get

/queues/{queueName}

Retrieve properties of the queue with the supplied name.

Request

Path Parameters

• queueName: string
  The name of the queue

Query Parameters

• backlog(optional): boolean
  Optional.  Whether to output the queue backlog.  The default value is false.  If true, then the response contains the count of messages on the queue.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The Name, status and link of the specified queue were returned

Body ()

Root Schema : queue

Type: object

A single queue info

Show Source

• backlogStats(optional): object backlogStats
  This is returned only if the backlog parameter was set to true on request.
• canonicalLink: string
  relative path to queue.
• name: string
  queue name
• status: string
  Allowed Values: [ "PROVISIONED", "MARK_FOR_DELETION" ]

  queue status, either PROVISIONED or MARK_FOR_DELETION

{
    "properties":{
        "name":{
            "type":"string",
            "description":"queue name"
        },
        "status":{
            "type":"string",
            "enum":[
                "PROVISIONED",
                "MARK_FOR_DELETION"
            ],
            "description":"queue status, either PROVISIONED or MARK_FOR_DELETION"
        },
        "canonicalLink":{
            "type":"string",
            "description":"relative path to queue."
        },
        "backlogStats":{
            "type":"object",
            "description":"This is returned only if the backlog parameter was set to true on request.",
            "properties":{
                "current":{
                    "type":"integer",
                    "description":"current size of the queue backlog"
                }
            }
        }
    },
    "type":"object",
    "required":[
        "name",
        "status",
        "canonicalLink"
    ],
    "description":"A single queue info"
}

Nested Schema : backlogStats

Type: object

This is returned only if the backlog parameter was set to true on request.

Show Source

• current(optional): integer
  current size of the queue backlog

{
    "type":"object",
    "description":"This is returned only if the backlog parameter was set to true on request.",
    "properties":{
        "current":{
            "type":"integer",
            "description":"current size of the queue backlog"
        }
    }
}

Example Response (application/json)

{
    "name":"name",
    "status":"PROVISIONED",
    "canonicalLink":"relative path to queue",
    "backlogStats":{
        "current":"10"
    }
}

404 Response

The queue with the name supplied was not found.

Back to Top

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/queues/myFirstQueue"

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

Example of Response Body

{ 
  "canonicalLink" : "/myService-myTenant/api/v1/queues/myFirstQueue"
, "name" : "myFirstQueue"
, "status" : "PROVISIONED"
}

Back to Top