Distributed Message Service (DMS)¶

The DMS client is the command-line interface (CLI) for the Distributed Message Service (DMS) API and its extensions.

For help on a specific dms command, enter:

$ openstack dms help SUBCOMMAND

Queue operations¶

dms queue create¶

Create DMS Queue

openstack dms queue create
    [--description <description>]
    [--redrive_policy <redrive_policy>]
    [--max_consume_count <max_consume_count>]
    [--retention_hours <retention_hours>]
    <name>
    <queue_mode>

--description <description>¶: Indicates the basic information about a queue. The queue description must be 0 to 160 characters in length, and does not contain angle brackets (<) and (>). NOTE: “" is defined as an escape character in the queue description. If you need to enter a backward slash () or a double quotation mark (”) in the queue description, enter or "

--redrive_policy <redrive_policy>¶: This parameter is mandatory only when queue_mode is NORMAL or FIFO. Indicates whether to enable dead letter messages. Dead letter messages indicate messages that cannot be normally consumed. If a message fails to be consumed after the number of consumption attempts of this message reaches the maximum value, DMS stores this message into the dead letter queue.This message will be retained in the deal letter queue for 72 hours. During this period, consumers can consume the dead letter message. Dead letter messages can be consumed only by the consumer group that generates these dead letter messages. Dead letter messages of a FIFO queue are stored and consumed based on the FIFO sequence. Options: * enable * disable Default value: disable.

--max_consume_count <max_consume_count>¶: This parameter is mandatory only when redrive_policy is set to enable. This parameter indicates the maximum number of allowed message consumption failures. When a message fails to be consumed after the number of consumption attempts of this message reaches this value, DMS stores this message into the dead letter queue. Value range: 1-100.

--retention_hours <retention_hours>¶: This parameter is mandatory only when queue_mode is set to KAFKA_HA or KAFKA_HT. This parameter indicates the retention time of messages in Kafka queues. Value range: 1 to 72 hours.

name¶: Name of the cluster.

queue_mode¶: Indicates the queue type. Options: * NORMAL: Standard queue. Best-effort ordering. Messages might be retrieved in an order different from which they were sent. Select standard queues when throughput is important. * FIFO: First-ln-First-out (FIFO) queue. FIFO delivery. Messages are retrieved in the order they were sent. Select FIFO queues when the order of messages is important. * KAFKA_HA: High-availability Kafka queue. All message replicas are flushed to a disk synchronously. Select the high availability mode when message reliability is important. * KAFKA_HT: High-throughput Kafka queue. All message replicas are flushed to a disk asynchronously. Select the high throughput mode when message delivery performance is important. Default value: NORMAL.

This command is provided by the otcextensions plugin.

dms queue delete¶

Delete DMS Queue

openstack dms queue delete <queue> [<queue> ...]

queue¶: ID of the queue

This command is provided by the otcextensions plugin.

dms queue list¶

List DMS Queues

openstack dms queue list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

dms queue show¶

Show single Queue details

openstack dms queue show <queue>

queue¶: ID of the queue

This command is provided by the otcextensions plugin.

Group operations¶

dms group create¶

Create DMS Group

openstack dms group create <queue> <name>

queue¶: ID of the queue

name¶: Name of the cluster.

This command is provided by the otcextensions plugin.

dms group delete¶

Delete DMS Group

openstack dms group delete <queue> <group> [<group> ...]

queue¶: ID of the queue

group¶: ID of the Group

This command is provided by the otcextensions plugin.

dms group list¶

List DMS Groups

openstack dms group list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--include_deadletter]
    <queue>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--include_deadletter¶: Indicates whether to list dead letter parameters in the response message.

queue¶: ID of the queue

This command is provided by the otcextensions plugin.

Instance operations¶

dms instance create¶

Create DMS Instance

openstack dms instance create
    [--description <description>]
    [--engine-name <engine>]
    [--engine-version <engine-ver>]
    --storage <GB>
    [--access-user <access_user>]
    [--password <password>]
    --router <router>
    --security-group <sg>
    --network <net>
    --availability-zone <AZ>
    --product-id <product>
    [--maintenance-begin <HH24:MM>]
    [--maintenance-end <HH24:MM>]
    [--enable-public-access]
    [--enable-ssl]
    [--public-bandwidth <Mbit/s>]
    [--retention-policy {produce_reject,time_base}]
    [--storage-spec-code {dms.physical.storage.high,dms.physical.storage.ultra}]
    <name>

--description <description>¶: Description of the instance.

--engine-name <engine>¶: Engine name. Currently only Kafka is supported.

--engine-version <engine-ver>¶: Engine version. Currently only “2.3.0” is supported.

--storage <GB>¶: Indicates the message storage space with increments of 100 GB: Instance with specification being 100MB: 600–90,000 GB Instance with specification being 300MB: 1,200–90,000 GB Instance with specification being 600MB: 2,400–90,000 GB Instance with specification being 1200MB: 4,800–90,000 GB

--access-user <access_user>¶: This parameter is mandatory when engine is set to kafka and ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false. Indicates a username. A username consists of 4 to 64 characters and supports only letters, digits, hyphens (-), and underscores (_).

--password <password>¶: This parameter is mandatory when engine is set to kafka and ssl_enable is set to true. This parameter is invalid when ssl_enable is set to false. An instance password must meet the following complexity requirements: - Must be a string consisting of 8 to 32 characters. - Must contain at least two of the following character types: – Lowercase letters – Uppercase letters – Digits – Special characters

--router <router>¶: Router ID or Name

--security-group <sg>¶: Security group ID or Name

--network <net>¶: Neutron network ID or Name

--availability-zone <AZ>¶: List of availability zones

--product-id <product>¶: Product ID of the DMS instance

--maintenance-begin <HH24:MM>¶: Start of the instance maintenance window

--maintenance-end <HH24:MM>¶: End of the instance maintenance window

--enable-public-access¶: Assign public ip to the instance

--enable-ssl¶: Enable SSL for the public access

--public-bandwidth <Mbit/s>¶: Public network bandwidth in Mbit/s: When specification 100MB: 3-900 When 300MB: 3-900 When 600MB: 4-1200 When 1200MB: 8-2400

--retention-policy {produce_reject,time_base}¶

Action to be taken when the memory usage reaches the disk capacity threshold. Options:: produce_reject: New messages cannot be created. time_base: The earliest messages are deleted.

--storage-spec-code {dms.physical.storage.high,dms.physical.storage.ultra}¶: The storage I/O specification of a Kafka instance. When specification is 100MB, the storage I/O can be:[dms.physical.storage.high, dms.physical.storage.ultra] When specification is 300MB, the storage I/O can be:[dms.physical.storage.high, dms.physical.storage.ultra] When specification is 600MB, the storage I/O is dms.physical.storage.ultra. When specification is 1200MB, the storage I/O is dms.physical.storage.ultra.

name¶: Name of the instance.

This command is provided by the otcextensions plugin.

dms instance list¶

List DMS Instances

openstack dms instance list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--engine-name <engine>]
    [--status {CREATING,CREATEFAILED,RUNNING,ERROR,STARTING,RESTARTING,CLOSING,FROZEN}]
    [--include-failure]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--engine-name <engine>¶: Engine name

--status {CREATING,CREATEFAILED,RUNNING,ERROR,STARTING,RESTARTING,CLOSING,FROZEN}¶: Instance status

--include-failure¶: Include instances failed to create

This command is provided by the otcextensions plugin.

dms instance restart¶

Restart single Instance

openstack dms instance restart <instance>

instance¶: ID of the instance

This command is provided by the otcextensions plugin.

dms instance set¶

Update DMS Instance

openstack dms instance set
    [--name <name>]
    [--description <description>]
    --security-group <sg>
    [--maintenance-begin <HH24:MM>]
    [--maintenance-end <HH24:MM>]
    <inst>

--name <name>¶: New name of the instance.

--description <description>¶: New description of the instance.

--security-group <sg>¶: Security group ID or Name

--maintenance-begin <HH24:MM>¶: Start of the instance maintenance window

--maintenance-end <HH24:MM>¶: End of the instance maintenance window

inst¶: Name or ID of the DMS instance

This command is provided by the otcextensions plugin.

dms instance show¶

Show single Instance details

openstack dms instance show <instance>

instance¶: ID of the instance

This command is provided by the otcextensions plugin.

dms instance topic create¶

Create DMS Instance Topic

openstack dms instance topic create
    [--partition <part>]
    [--replication <repl>]
    [--retention-time <hours>]
    [--enable-sync-flush]
    [--enable-sync-replication]
    <instance>
    <id>

--partition <part>¶: The number of topic partitions, which is used to set the number of concurrently consumed messages. Value range: 1–20. Default value: 3.

--replication <repl>¶: The number of replicas, which is configured to ensure data reliability. Value range: 1–3. Default value: 3.

--retention-time <hours>¶: The retention period of a message. Its default value is 72. Value range: 1–168. Default value: 72. Unit: hour.

--enable-sync-flush¶: Whether to enable synchronous flushing. Default value: false. Synchronous flushing compromises performance.

--enable-sync-replication¶: Whether to enable synchronous replication. After this function is enabled, the acks parameter on the producer client must be set to –1. Otherwise, this parameter does not take effect.

instance¶: Instance ID or Name.

id¶: Name/ID of the topic.

This command is provided by the otcextensions plugin.

dms instance topic delete¶

Delete DMS Instance Topic

openstack dms instance topic delete <instance> <topic> [<topic> ...]

instance¶: ID or name of the Instance

topic¶: Topic ID

This command is provided by the otcextensions plugin.

dms instance topic list¶

List DMS Instance topics

openstack dms instance topic list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <instance>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

instance¶: DMS Instance name or ID

This command is provided by the otcextensions plugin.

Misc operations¶

dms az list¶

List Availability zones

openstack dms az list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

dms maintenance window list¶

List Maintenance Windows

openstack dms maintenance window list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

dms product list¶

List Product specs

openstack dms product list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

last updated: UTC - commit: