RabbitMQ 所有 HTTP API 接口中文说明

 

GET	PUT	DELETE	POST	Path	描述
X				/api/overview	描述整体的各种随机信息位 系统。
X	X			/api/cluster-name	标识此 RabbitMQ 集群的名称。
X				/api/nodes	RabbitMQ 集群中的节点列表。
X				/api/nodes/name	RabbitMQ 集群中的单个节点。加 “？memory=true” 获取内存统计信息。
X				/api/extensions	管理插件的扩展列表。
X			X	/api/definitions	服务器定义 – 交换、队列、绑定、用户、 虚拟主机、权限和参数。除了 消息。POST 上传一组现有定义。注意 那：
				/api/all-configuration (deprecated)
					定义将合并。任何已经存在的东西都是 原封不动。
					冲突将导致错误。
					如果发生错误，您将得到一个 部分应用的定义集。
					为方便起见，您可以将文件从浏览器上传到此 URI（即您可以用作 以及 ） 在这种情况下， 定义应作为名为 “文件”。multipart/form-dataapplication/json
X				/api/connections	所有打开的连接的列表。
X		X		/api/connections/name	单个连接。DELETE命令将关闭 连接。（可选）在以下情况下设置“X-Reason”标头 DELETEing 以提供原因。
X				/api/connections/name/channels	给定连接的所有通道的列表。
X				/api/channels	所有开放频道的列表。
X				/api/channels/channel	有关单个频道的详细信息。
X				/api/exchanges	所有交易所的列表。
X				/api/exchanges/vhost	给定虚拟主机中所有交换的列表。
X	X	X		/api/exchanges/vhost/name	个人交流。要进行交换，您需要一个看起来像这样的正文：密钥是强制性的;其他键是可选的。
					{“type”:”direct”,”auto_delete”:false,”durable”:true,”internal”:false,”arguments”:[]}
					type
X				/api/exchanges/vhost/name/bindings/source	以给定交换为源的所有绑定的列表。
X				/api/exchanges/vhost/name/bindings/destination	给定交换是目标的所有绑定的列表。
			X	/api/exchanges/vhost/name/publish	将消息发布到给定的交易所。你将需要一个身体 看起来像：所有键都是必需的。密钥应为“字符串”（在本例中为有效负载 将被视为有效负载字段的 UTF-8 编码） 或“base64”（在这种情况下，有效负载字段被视为 base64 编码）。
					如果消息发布成功，响应将 如下所示：如果消息被发送到 至少一个队列。
					{“properties”:{},”routing_key”:”my key”,”payload”:”my body”,”payload_encoding”:”string”}
					payload_encoding
					{“routed”: true}
					routed
					请注意，HTTP API 中的发布/获取路径是 用于注入测试消息、诊断等 – 它们不是 实现可靠的交付，因此应被视为系统管理员的 工具，而不是用于消息传递的通用 API。
X				/api/queues	所有队列的列表。
X				/api/queues/vhost	给定虚拟主机中所有队列的列表。
X	X	X		/api/queues/vhost/name	单个队列。要 PUT 队列，您需要一个如下所示的正文： 所有键都是可选的。
					{“auto_delete”:false,”durable”:true,”arguments”:[],”node”:”rabbit@smacmullen”}
X				/api/queues/vhost/name/bindings	给定队列上所有绑定的列表。
		X		/api/queues/vhost/name/contents	队列的内容。DELETE 清除。请注意，您不能得到这个。
			X	/api/queues/vhost/name/actions	可以对队列执行的操作。POST 一个正文，如下所示：当前操作 支持的是 和 。
					{“action”:”sync”}
					synccancel_sync
			X	/api/queues/vhost/name/get	从队列中获取消息。（这不是一个 HTTP GET，因为它 将更改队列的状态。您应该发布如下所示的正文：
					{“count”:5,”requeue”:true,”encoding”:”auto”,”truncate”:50000}
					count控制最大数量 要获取的消息。如果出现以下情况，您收到的消息可能会少于此值 队列无法立即提供它们。
					requeue确定消息是否为 已从队列中删除。如果重新排队为 true，则它们将被重新排队 – 但他们的旗帜将被设定。redelivered
					encoding必须是“auto”（在这种情况下 如果有效 UTF-8，则 payload 将作为字符串返回，并且 base64 编码），或“base64”（在这种情况下，有效负载 将始终是 base64 编码）。
					如果存在，它将截断 消息有效负载（如果大于给定的大小（以字节为单位）。truncate
					truncate是可选的;所有其他密钥都是必需的。
					请注意，HTTP API 中的发布/获取路径是 用于注入测试消息、诊断等 – 它们不是 实现可靠的交付，因此应被视为系统管理员的 工具，而不是用于消息传递的通用 API。
X				/api/bindings	所有绑定的列表。
X				/api/bindings/vhost	给定虚拟主机中所有绑定的列表。
X			X	/api/bindings/vhost/e/exchange/q/queue	交易所和 队列。请记住，交换和队列是可以绑定的 一起很多次！若要创建新绑定，请对此进行 POST URI。您将需要一个看起来像这样的正文：所有键都是可选的。 响应将包含一个标头 告诉您新绑定的 URI。
					{“routing_key”:”my_routing_key”,”arguments”:[]}
					Location
X		X		/api/bindings/vhost/e/exchange/q/queue/props	交换和队列之间的单独绑定。 URI 的 props 部分是绑定的“名称” 由其路由键和参数的哈希值组成。
X			X	/api/bindings/vhost/e/source/e/destination	两个交易所之间的所有绑定的列表。似 Exchange 和队列之间的所有绑定的列表， 以上。
X		X		/api/bindings/vhost/e/source/e/destination/props	两个交易所之间的单独绑定。似 交换和队列之间的单独绑定， 以上。
X				/api/vhosts	所有 vhost 的列表。
X	X	X		/api/vhosts/name	单个虚拟主机。作为虚拟主机，通常只 有一个名字，你在 PUTing 其中一个时不需要 HTTP 正文 这些。若要启用/禁用跟踪，请提供如下所示的正文：
					{“tracing”:true}
X				/api/vhosts/name/permissions	给定虚拟主机的所有权限的列表。
X				/api/users	所有用户的列表。
X	X	X		/api/users/name	单个用户。要 PUT 用户，您需要一个如下所示的正文： 或者： 密钥是必需的。要么设置，要么必须设置。设置为 “” 将确保 用户无法使用密码登录。 是一个 以逗号分隔的用户标记列表。当前识别的标签 分别是“管理员”、“监控”和“管理”。
					{“password”:”secret”,”tags”:”administrator”}
					{“password_hash”:”2lmoth8l4H0DViLaK9Fxi6l9ds8=”, “tags”:”administrator”}
					tagspasswordpassword_hashpassword_hashtags
X				/api/users/user/permissions	给定用户的所有权限的列表。
X				/api/whoami	当前已通过身份验证的用户的详细信息。
X				/api/permissions	所有用户的所有权限的列表。
X	X	X		/api/permissions/vhost/user	用户和虚拟主机的个人权限。要 PUT 权限，您需要一个如下所示的正文： 所有键都是必需的。
					{“configure”:”.*”,”write”:”.*”,”read”:”.*”}
X				/api/parameters	所有参数的列表。
X				/api/parameters/component	给定组件的所有参数的列表。
X				/api/parameters/component/vhost	给定组件和虚拟主机的所有参数的列表。
X	X	X		/api/parameters/component/vhost/name	单个参数。要 PUT 一个参数，您需要一个如下所示的正文：
					{“vhost”: “/”,”component”:”federation”,”name”:”local_username”,”value”:”guest”}
X				/api/policies	所有策略的列表。
X				/api/policies/vhost	给定虚拟主机中所有策略的列表。
X	X	X		/api/policies/vhost/name	个人策略。要 PUT 策略，您需要一个如下所示的正文：并且是强制性的，并且是可选的。
					{“pattern”:”^amq.”, “definition”: {“federation-upstream-set”:”all”}, “priority”:0, “apply-to”: “all”}
					patterndefinitionpriorityapply-to
X				/api/aliveness-test/vhost	声明一个测试队列，然后发布并使用一个 消息。供监视工具使用。如果一切 工作正常，将返回 HTTP 状态 200 body： 注意：测试队列将 不被删除（如果是，以防止队列改动 反复 ping）。
					{“status”:”ok”}