8f0b9f5b07
The doc of message is missing in zaqarclient. So this patch will add it and also remove the unused docs for other resources. Change-Id: I55c745a81226487292220edfb629ca4f7dfd95d7 Closes-Bug: #1893145 Signed-off-by: wanghao <sxmatch1986@gmail.com>
200 lines
5.2 KiB
ReStructuredText
200 lines
5.2 KiB
ReStructuredText
Queue
|
|
=====
|
|
|
|
For help on a specific :command:`openstack messaging queue` command, enter:
|
|
|
|
.. code-block:: console
|
|
|
|
$ openstack messaging queue COMMAND -h/--help
|
|
|
|
The fourteen commands:
|
|
|
|
.. code-block:: console
|
|
|
|
messaging queue create
|
|
messaging queue delete
|
|
messaging queue get metadata
|
|
messaging queue list
|
|
messaging queue set metadata
|
|
messaging queue signed url
|
|
messaging queue stats
|
|
|
|
.. _openstack_messaging_queue_create:
|
|
|
|
openstack messaging queue create
|
|
--------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue create [-h] [-f {json,shell,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<queue_name>
|
|
|
|
Create a queue.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<queue_name>``
|
|
Name of the queue.
|
|
|
|
.. _openstack_messaging_queue_delete:
|
|
|
|
openstack messaging queue delete
|
|
--------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue delete [-h] <queue_name>
|
|
|
|
Delete a queue.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<queue_name>``
|
|
Name of the queue.
|
|
|
|
.. _openstack_messaging_queue_get_metadata:
|
|
|
|
openstack messaging queue get metadata
|
|
--------------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue get metadata [-h] [-f {json,shell,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
<queue_name>
|
|
|
|
Get queue metadata.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<queue_name>``
|
|
Name of the queue.
|
|
|
|
.. _openstack_messaging_queue_list:
|
|
|
|
openstack messaging queue list
|
|
------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN]
|
|
[--max-width <integer>] [--noindent]
|
|
[--quote {all,minimal,none,nonnumeric}]
|
|
[--marker <queue_id>] [--limit <limit>]
|
|
[--detailed]
|
|
|
|
List available queues.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--marker <queue_id>``
|
|
Queue's paging marker.
|
|
|
|
``--limit <limit>``
|
|
Page size limit.
|
|
|
|
``--detailed``
|
|
If show detailed information of queue.
|
|
|
|
.. _openstack_messaging_queue_set_metadata:
|
|
|
|
openstack messaging queue set metadata
|
|
--------------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue set metadata [-h] <queue_name> <queue_metadata>
|
|
|
|
Set queue metadata.All the metadata of the queue will be replaced by
|
|
queue_metadata.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<queue_name>``
|
|
Name of the queue.
|
|
|
|
``<queue_metadata>``
|
|
Queue metadata. It should be json like. For example: '{"age": 18}'
|
|
|
|
.. _openstack_messaging_queue_signed_url:
|
|
|
|
openstack messaging queue signed url
|
|
------------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue signed url [-h] [-f {json,shell,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>]
|
|
[--noindent] [--prefix PREFIX]
|
|
[--paths <paths>]
|
|
[--ttl-seconds <ttl_seconds>]
|
|
[--methods <methods>]
|
|
<queue_name>
|
|
|
|
Create a pre-signed url for the queue.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<queue_name>``
|
|
Name of the queue.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--paths <paths>``
|
|
Allowed paths in a comma-separated list.
|
|
Options: messages, subscriptions, claims.
|
|
|
|
``--ttl-seconds <ttl_seconds>``
|
|
Length of time (in seconds) until the signature expires.
|
|
|
|
``--methods <methods>``
|
|
HTTP methods to allow as a comma-separated list.
|
|
Options: GET, HEAD, OPTIONS, POST, PUT, DELETE.
|
|
|
|
.. _openstack_messaging_queue_stats:
|
|
|
|
openstack messaging queue stats
|
|
-------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue stats [-h] [-f {json,shell,table,value,yaml}]
|
|
[-c COLUMN] [--max-width <integer>] [--noindent]
|
|
[--prefix PREFIX]
|
|
<queue_name>
|
|
|
|
Get queue stats.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<queue_name>``
|
|
Name of the queue.
|
|
|
|
.. _openstack_messaging_queue_purge:
|
|
|
|
openstack messaging queue purge
|
|
-------------------------------
|
|
|
|
.. code-block:: console
|
|
|
|
usage: openstack messaging queue purge [-h] [--resource_types <resource_types>]
|
|
<queue_name>
|
|
|
|
Purge a queue. All the metadata of the queue will be kept. Use
|
|
``--resource_types`` to specify which resource should be pured. If
|
|
``--resource_types`` is not specified, all the messages and subscriptions in
|
|
the queue will be purged by default.
|
|
|
|
**Positional arguments:**
|
|
|
|
``<queue_name>``
|
|
Name of the queue.
|
|
|
|
**Optional arguments:**
|
|
|
|
``--resource_types <resource_types>``
|
|
Resource types want to be purged. Support ``messages`` and ``subscriptions``.
|