Download the PHP package imega/rabbitmq-management-api without Composer

Rabman

A simple object oriented wrapper for the RabbitMQ Management HTTP Api.

Installation

Installable through composer via:

Table of Contents

• Installation
• Modificators
• Overview
• Cluster
• Nodes
• Extensions
• Definition
• Connections
• Channels
• Consumers
• Exchanges
• Queues
• Bindings
• Vhosts
• Users
• Whoami
• Permissions
• Parameters
• Policies
• Aliveness
• License

Modificators

• sort
• columns

Sort allows you to select a primary field to sort by, and second paramenter will reverse the sort order if set to true. The sort first parameter can contain subfields separated by dots. This allows you to sort by a nested component of the listed items; it does not allow you to sort by more than one field. See the example below.

You can also restrict what information is returned per item with the columns parameter.

Back to TOC

Overview

Various random bits of information that describe the whole system.

Back to TOC

Cluster

Name identifying this RabbitMQ cluster.

and rename cluster

Back to TOC

Nodes

A list of nodes in the RabbitMQ cluster.

An individual node in the RabbitMQ cluster.

Back to TOC

Extensions

A list of extensions to the management plugin.

Back to TOC

Definition

The server definitions - exchanges, queues, bindings, users, virtual hosts, permissions and parameters. Everything apart from messages.

Create to upload an existing set of definitions. Note that:

• The definitions are merged. Anything already existing on the server but not in the uploaded definitions is untouched.
• Conflicting definitions on immutable objects (exchanges, queues and bindings) will cause an error.
• Conflicting definitions on mutable objects will cause the object in the server to be overwritten with the object from the definitions.
• In the event of an error you will be left with a part-applied set of definitions.

The server definitions for a given virtual host - exchanges, queues, bindings and policies.

Create to upload an existing set of definitions for a given virtual host. Note that:

• The definitions are merged. Anything already existing on the server but not in the uploaded definitions is untouched.
• Conflicting definitions on immutable objects (exchanges, queues and bindings) will cause an error.
• Conflicting definitions on mutable objects will cause the object in the server to be overwritten with the object from the definitions.
• In the event of an error you will be left with a part-applied set of definitions.

Back to TOC

Connections

A list of all open connections.

A list of all open connections in a specific vhost.

An individual connection.

DELETEing it will close the connection.

List of all channels for a given connection.

Back to TOC

Channels

A list of all open channels.

A list of all open channels in a specific vhost.

Details about an individual channel.

Back to TOC

Consumers

A list of all consumers.

A list of all consumers in a given virtual host.

Back to TOC

Exchanges

A list of all exchanges.

A list of all exchanges in a given virtual host.

An individual exchange.

Create an exchange.

When DELETEing an exchange you can add the options 'if-unused' => true. This prevents the delete from succeeding if the exchange is bound to a queue or as a source to another exchange.

A list of all bindings in which a given exchange is the source.

A list of all bindings in which a given exchange is the destination.

Publish a message to a given exchange. You will need the options looking something like:

"routed" => true routed will be true if the message was sent to at least one queue.

Back to TOC

Queues

A list of all queues.

A list of all queues in a given virtual host.

An individual queue.

To create a queue, you will need the parameters looking something like this (All keys are optional):

When DELETEing a queue you can add the query string parameters if-empty=true and / or if-unused=true. These prevent the delete from succeeding if the queue contains messages, or has consumers, respectively.

A list of all bindings on a given queue.

Contents of a queue to purge.

Actions that can be taken on a queue.

Currently the actions which are supported are sync and cancel_sync.

Get messages from a queue.

• count controls the maximum number of messages to get. You may get fewer messages than this if the queue cannot immediately provide them.
• requeue determines whether the messages will be removed from the queue. If requeue is true they will be requeued - but their redelivered flag will be set.
• encoding must be either "auto" (in which case the payload will be returned as a string if it is valid UTF-8, and base64 encoded otherwise), or "base64" (in which case the payload will always be base64 encoded).
• If truncate is present it will truncate the message payload if it is larger than the size given (in bytes).

truncate is optional; all other keys are mandatory.

Please note that the get path in the HTTP API is intended for diagnostics etc - it does not implement reliable delivery and so should be treated as a sysadmin's tool rather than a general API for messaging.

Back to TOC

Bindings

A list of all bindings.

A list of all bindings in a given virtual host.

A list of all bindings between an exchange and a queue.

Remember, an exchange and a queue can be bound together many times! To create a new binding, POST to this URI. You will need a body looking something like this:

An individual binding between an exchange and a queue. The props is a "name" for the binding composed of its routing key and a hash of its arguments.

and delete the binding

A list of all bindings between two exchanges. Similar to the list of all bindings between an exchange and a queue, above.

An individual binding between two exchanges. Similar to the individual binding between an exchange and a queue, above. The props is a "name" for the binding composed of its routing key and a hash of its arguments.

and delete

Back to TOC

Vhosts

A list of all vhosts.

An individual virtual host.

A list of all permissions for a given virtual host.

Back to TOC

Users

A list of all users.

An individual user.

To create a user, you will need the parameters looking something like this:

or

The tags key is mandatory. Either password or password_hash must be set. Setting password_hash to "" will ensure the user cannot use a password to log in. tags is a comma-separated list of tags for the user. Currently recognised tags are "administrator", "monitoring" and "management".

and delete a user

A list of all permissions for a given user.

Back to TOC

Whoami

Details of the currently authenticated user.

Back to TOC

Permissions

A list of all permissions for all users.

An individual permission of a user and virtual host.

To create a permission, you will need the parameters looking something like this (All keys are mandatory):

and delete a user

Back to TOC

Parameters

A list of all parameters.

A list of all parameters for a given component.

A list of all parameters for a given component and virtual host.

An individual parameter.

To create a parameter, you will need the parameters looking something like this:

and delete a parameter

Back to TOC

Policies

A list of all policies.

A list of all policies in a given virtual host.

An individual policy.

To create a policy, you will need the parameters looking something like this:

and delete a policy

Back to TOC

Aliveness

Declares a test queue, then publishes and consumes a message. Intended for use by monitoring tools. If everything is working correctly, will return "status" => "ok"

Note: the test queue will not be deleted (to to prevent queue churn if this is repeatedly pinged).

Back to TOC

License

The MIT License (MIT)

Copyright (c) 2015 Dmitry Gavrilov [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.