我的书签
添加书签
移除书签Pulsar admin CLI
pulsar-admin 工具能让你管理 Pulsar 安装，包括集群、broker、命名空间、租户等等。
用法
Commands
broker-statsbrokersclustersfunctionsfunctions-workernamespacesns-isolation-policysourcesFor more information, see here
sinksFor more information, see
topicsresource-quotasschemas
Operations to collect broker statistics
$ pulsar-admin broker-stats subcommand
Subcommands
allocator-statstopics(destinations)mbeansmonitoring-metricsload-report
Dump allocator stats
用法
$ pulsar-admin broker-stats allocator-stats allocator-name
topics(destinations)
Dump topic stats
用法
$ pulsar-admin broker-stats topics options
选项
mbeans
Dump Mbean stats
用法
$ pulsar-admin broker-stats mbeans options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-i, —indent | JSON 以缩进方式输出 | false |
monitoring-metrics
Dump metrics for monitoring
用法
$ pulsar-admin broker-stats monitoring-metrics options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-i, —indent | JSON 以缩进方式输出 | false |
load-report
Dump broker load-report
用法
$ pulsar-admin broker-stats load-report
brokers
Operations about brokers
$ pulsar-admin brokers subcommand
Subcommands
listnamespacesupdate-dynamic-configlist-dynamic-configget-all-dynamic-configget-internal-configget-runtime-confighealthcheck
list
List active brokers of the cluster
用法
$ pulsar-admin brokers list cluster-name
leader-broker
获取 leader broker 信息
用法
$ pulsar-admin brokers leader-broker
namespaces
List namespaces owned by the broker
用法
$ pulsar-admin brokers namespaces cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—url | Broker 的 URL |
update-dynamic-config
Update a broker’s dynamic service configuration
用法
$ pulsar-admin brokers update-dynamic-config options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—config | 服务配置的参数名称 | |
—value | 使用 —config 标志指定的配置参数的值 |
list-dynamic-config
Get list of updatable configuration name
用法
$ pulsar-admin brokers list-dynamic-config
delete-dynamic-config
删除 broker 的 dynamic-serviceConfiguration
用法
$ pulsar-admin brokers delete-dynamic-config options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—config | 服务配置的参数名称 |
get-all-dynamic-config
Get all overridden dynamic-configuration values
用法
$ pulsar-admin brokers get-all-dynamic-config
get-internal-config
Get internal configuration information
用法
$ pulsar-admin brokers get-internal-config
get-runtime-config
Get runtime configuration values
用法
$ pulsar-admin brokers get-runtime-config
healthcheck
Run a health check against the broker
用法
$ pulsar-admin brokers healthcheck
clusters
Operations about clusters
用法
$ pulsar-admin clusters subcommand
Subcommands
getcreateupdatedeletelistupdate-peer-clustersget-peer-clustersget-failure-domaincreate-failure-domainupdate-failure-domaindelete-failure-domainlist-failure-domains
get
Get the configuration data for the specified cluster
用法
$ pulsar-admin clusters get cluster-name
create
Provisions a new cluster. This operation requires Pulsar super-user privileges.
用法
$ pulsar-admin clusters create cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—broker-url | Broker 的 URL。 | |
—broker-url-secure | 用于安全连接的 broker URL | |
—url | service-url | |
—url-secure | 用于安全连接的服务 URL |
update
Update the configuration for a cluster
用法
$ pulsar-admin clusters update cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—broker-url | Broker 的 URL。 | |
—broker-url-secure | 用于安全连接的 broker URL | |
—url | service-url | |
—url-secure | 用于安全连接的服务 URL |
delete
Deletes an existing cluster
用法
$ pulsar-admin clusters delete cluster-name
list
List the existing clusters
用法
$ pulsar-admin clusters list
update-peer-clusters
Update peer cluster names
用法
$ pulsar-admin clusters update-peer-clusters cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—peer-clusters | 逗号分隔的对等集群名称（传递空字符串 “” 来删除列表） |
get-peer-clusters
Get list of peer clusters
用法
$ pulsar-admin clusters get-peer-clusters
get-failure-domain
Get the configuration brokers of a failure domain
用法
$ pulsar-admin clusters get-failure-domain cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—domain-name | 故障域名，这是 Pulsar 集群下的逻辑域 |
create-failure-domain
Create a new failure domain for a cluster (updates it if already created)
用法
$ pulsar-admin clusters create-failure-domain cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—broker-list | 以逗号分隔的 broker 列表 | |
—domain-name | 故障域名，这是 Pulsar 集群下的逻辑域 |
update-failure-domain
Update failure domain for a cluster (creates a new one if not exist)
用法
$ pulsar-admin clusters update-failure-domain cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—broker-list | 以逗号分隔的 broker 列表 | |
—domain-name | 故障域名，这是 Pulsar 集群下的逻辑域 |
delete-failure-domain
Delete an existing failure domain
用法
$ pulsar-admin clusters delete-failure-domain cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—domain-name | 故障域名，这是 Pulsar 集群下的逻辑域 |
list-failure-domains
List the existing failure domains for a cluster
用法
$ pulsar-admin clusters list-failure-domains cluster-name
A command-line interface for Pulsar Functions
用法
$ pulsar-admin functions subcommand
Subcommands
localruncreatedeleteupdategetrestartstopstartstatusstatslistquerystateputstatetrigger
localrun
Run the Pulsar Function locally (rather than deploying it to the Pulsar cluster)
用法
$ pulsar-admin functions localrun options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—cpu | 每个 function 实例需要分配的 cpu 核数（仅适用于在 docker 上运行时） | |
—ram | 每个 function 实例需要分配的 ram 字节数（仅适用于以进程运行或在 docker 上运行时）。 | |
—disk | 每个 function 实例需要分配的磁盘字节数（仅适用于在 docker 上运行时）。 | |
—auto-ack | 框架是否会自动确认消息 | |
—subs-name | 如果用户想为输入主题的消费者设置特定订阅名称，可以使用该参数设置 Pulsar 源订阅名称 | |
—broker-service-url | Pulsar broker 的 URL | |
—classname | Function 的类名称 | |
—custom-serde-inputs | 输入主题到 SerDe 类名称的映射（以 JSON 字符串的形式）。 | |
—custom-schema-inputs | 输入主题到 Schema 类名称的映射（以 JSON 字符串的形式）。 | |
—client-auth-params | 客户端身份验证参数。 | |
—client-auth-plugin | 客户端身份验证插件，function 进程需要通过此插件连接到 broker。 | |
—function-config-file | 配置 Pulsar Function 的 YAML 配置文件的路径。 | |
—hostname-verification-enabled | 启用主机名称验证 | false |
—instance-id-offset | 从该设置的偏移量启动实例 | 0 |
—inputs | Function 的输入主题（多个 topic 可以用逗号分隔） | |
—log-topic | 用于 Function 输出日志的主题 | |
—jar | Path to the jar file for the function (if the function is written in Java). 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—output | Function 的输出主题（如果未指定，则不做输出） | |
—output-serde-classname | Function 输出消息时使用的 SerDe 类 | |
—parallelism | Function 的并行化参数，也就是要运行 function 实例的个数 | 1 |
—processing-guarantees | The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE] | ATLEAST_ONCE |
—py | Function 的主可执行 Python 文件/Python Wheel 文件路径（如果 function 是用 Python 编写的）。 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—go | Function 的主可执行 Go 二进制文件路径（如果 function 是用 Go 编写的）。 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—schema-type | Function 用于输出消息的内置 schema 类型或自定义 schema 类名。 | |
—sliding-interval-count | 窗口滑动后的消息数量。 | |
—sliding-interval-duration-ms | 窗口滑动后的持续时间。 | |
—state-storage-service-url | The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally. | |
—tenant | Function 的租户 | |
—topics-pattern | The topic pattern to consume from list of topics under a namespace that match the pattern. [—input] and [—topic-pattern] are mutually exclusive. 使用 —custom-serde-inputs 配置为模式添加 SerDe 类名称（仅适用于 Java Function）。 | |
—user-config | 用户定义的配置键/值。 | |
—window-length-count | 每个窗口的消息数量 | |
—window-length-duration-ms | 窗口的持续时间（以毫秒为单位） | |
—dead-letter-topic | 所有无法成功处理的消息将发往该主题 | |
—fqfn | 此 function 的完全限定名称（FQFN） | |
—max-message-retries | 在放弃之前，应该尝试处理消息的最大次数 | |
—retain-ordering | Function 按顺序消费并处理消息。 | |
—retain-key-ordering | Function 按 Key 的顺序消费并处理消息 | |
—timeout-ms | 消息确认的超时时间（以毫秒为单位） | |
—tls-allow-insecure | 允许不安全的 TLS 连接 | false |
—tls-trust-cert-path | TLS 信任证书文件路径 | |
—use-tls | 使用 TLS 连接 | false |
—producer-config | 自定义生产者配置(以 JSON 字符串形式) |
create
Create a Pulsar Function in cluster mode (i.e. deploy it on a Pulsar cluster)
用法
$ pulsar-admin functions create options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—cpu | 每个 function 实例需要分配的 cpu 核数（仅适用于在 docker 上运行时） | |
—ram | 每个 function 实例需要分配的 ram 字节数（仅适用于以进程运行或在 docker 上运行时）。 | |
—disk | 每个 function 实例需要分配的磁盘字节数（仅适用于在 docker 上运行时）。 | |
—auto-ack | 框架是否会自动确认消息 | |
—subs-name | 如果用户想为输入主题的消费者设置特定订阅名称，可以使用该参数设置 Pulsar 源订阅名称 | |
—classname | Function 的类名称 | |
—custom-serde-inputs | 输入主题到 SerDe 类名称的映射（以 JSON 字符串的形式）。 | |
—custom-schema-inputs | 输入主题到 Schema 类名称的映射（以 JSON 字符串的形式）。 | |
—function-config-file | 配置 Pulsar Function 的 YAML 配置文件的路径。 | |
—inputs | Function 的输入主题（多个 topic 可以用逗号分隔） | |
—log-topic | 用于 Function 输出日志的主题 | |
—jar | Path to the jar file for the function (if the function is written in Java). 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—output | Function 的输出主题（如果未指定，则不做输出） | |
—output-serde-classname | Function 输出消息时使用的 SerDe 类 | |
—parallelism | Function 的并行化参数，也就是要运行 function 实例的个数 | 1 |
—processing-guarantees | The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE] | ATLEAST_ONCE |
—py | Function 的主可执行 Python 文件/Python Wheel 文件路径（如果 function 是用 Python 编写的）。 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—go | Function 的主可执行 Go 二进制文件路径（如果 function 是用 Go 编写的）。 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—schema-type | Function 用于输出消息的内置 schema 类型或自定义 schema 类名。 | |
—sliding-interval-count | 窗口滑动后的消息数量。 | |
—sliding-interval-duration-ms | 窗口滑动后的持续时间。 | |
—tenant | Function 的租户 | |
—topics-pattern | The topic pattern to consume from list of topics under a namespace that match the pattern. [—input] and [—topic-pattern] are mutually exclusive. 使用 —custom-serde-inputs 配置为模式添加 SerDe 类名称（仅适用于 Java Function）。 | |
—user-config | 用户定义的配置键/值。 | |
—window-length-count | 每个窗口的消息数量 | |
—window-length-duration-ms | 窗口的持续时间（以毫秒为单位） | |
—dead-letter-topic | 所有无法成功处理的消息将发往该主题 | |
—fqfn | 此 function 的完全限定名称（FQFN） | |
—max-message-retries | 在放弃之前，应该尝试处理消息的最大次数 | |
—retain-ordering | Function 按顺序消费并处理消息。 | |
—retain-key-ordering | Function 按 Key 的顺序消费并处理消息 | |
—timeout-ms | 消息确认的超时时间（以毫秒为单位） | |
—producer-config | 自定义生产者配置(以 JSON 字符串形式) |
delete
Delete a Pulsar Function that’s running on a Pulsar cluster
用法
$ pulsar-admin functions delete options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
update
Update a Pulsar Function that’s been deployed to a Pulsar cluster
用法
$ pulsar-admin functions update options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—cpu | 每个 function 实例需要分配的 cpu 核数（仅适用于在 docker 上运行时） | |
—ram | 每个 function 实例需要分配的 ram 字节数（仅适用于以进程运行或在 docker 上运行时）。 | |
—disk | 每个 function 实例需要分配的磁盘字节数（仅适用于在 docker 上运行时）。 | |
—auto-ack | 框架是否会自动确认消息 | |
| 如果用户想为输入主题的消费者设置特定订阅名称，可以使用该参数设置 Pulsar 源订阅名称 | ||
—classname | Function 的类名称 | |
—custom-serde-inputs | 输入主题到 SerDe 类名称的映射（以 JSON 字符串的形式）。 | |
—custom-schema-inputs | 输入主题到 Schema 类名称的映射（以 JSON 字符串的形式）。 | |
—function-config-file | 配置 Pulsar Function 的 YAML 配置文件的路径。 | |
—inputs | Function 的输入主题（多个 topic 可以用逗号分隔） | |
—log-topic | 用于 Function 输出日志的主题 | |
—jar | Path to the jar file for the function (if the function is written in Java). 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—output | Function 的输出主题（如果未指定，则不做输出） | |
—output-serde-classname | Function 输出消息时使用的 SerDe 类 | |
—parallelism | Function 的并行化参数，也就是要运行 function 实例的个数 | 1 |
—processing-guarantees | The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE] | ATLEAST_ONCE |
—py | Function 的主可执行 Python 文件/Python Wheel 文件路径（如果 function 是用 Python 编写的）。 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—go | Function 的主可执行 Go 二进制文件路径（如果 function 是用 Go 编写的）。 支持 URL 路径 [http/https/file (文件协议假定文件已在 worker 主机上)/function (包管理服务的软件包 URL)]，worker 可从中下载包。 | |
—schema-type | Function 用于输出消息的内置 schema 类型或自定义 schema 类名。 | |
—sliding-interval-count | 窗口滑动后的消息数量。 | |
—sliding-interval-duration-ms | 窗口滑动后的持续时间。 | |
—tenant | Function 的租户 | |
—topics-pattern | The topic pattern to consume from list of topics under a namespace that match the pattern. [—input] and [—topic-pattern] are mutually exclusive. 使用 —custom-serde-inputs 配置为模式添加 SerDe 类名称（仅适用于 Java Function）。 | |
—user-config | 用户定义的配置键/值。 | |
—window-length-count | 每个窗口的消息数量 | |
—window-length-duration-ms | 窗口的持续时间（以毫秒为单位） | |
—dead-letter-topic | 所有无法成功处理的消息将发往该主题 | |
—fqfn | 此 function 的完全限定名称（FQFN） | |
—max-message-retries | 在放弃之前，应该尝试处理消息的最大次数 | |
—retain-ordering | Function 按顺序消费并处理消息。 | |
—retain-key-ordering | Function 按 Key 的顺序消费并处理消息 | |
—timeout-ms | 消息确认的超时时间（以毫秒为单位） | |
—producer-config | 自定义生产者配置(以 JSON 字符串形式) |
get
Fetch information about a Pulsar Function
用法
$ pulsar-admin functions get options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
restart
Restart function instance
用法
$ pulsar-admin functions restart options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—instance-id | Function 实例 id (如果没有提供实例 id，则重启所有实例） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
stop
Stops function instance
用法
$ pulsar-admin functions stop options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—instance-id | Function 实例 id (如果没有提供实例 id，则关闭所有实例） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
start
Starts a stopped function instance
用法
$ pulsar-admin functions start options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—instance-id | Function 实例 id (如果没有提供实例 id，则启动所有实例） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
status
Check the current status of a Pulsar Function
用法
$ pulsar-admin functions status options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—instance-id | Function 实例 id (如果没有提供实例 id，则获取所有实例的的状态） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
stats
Get the current stats of a Pulsar Function
用法
$ pulsar-admin functions stats options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—instance-id | Function 实例 id (如果没有提供实例 id，则获取所有实例的的状态） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
list
List all of the Pulsar Functions running under a specific tenant and namespace
用法
$ pulsar-admin functions list options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 |
querystate
Fetch the current state associated with a Pulsar Function running in cluster mode
用法
$ pulsar-admin functions querystate options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
-k, —key | 想要获取的状态对应的关键字 | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 | |
-w, —watch | 监视与 Pulsar Function 键相关值的变化 | false |
putstate
将键/值对插入到与 Pulsar Function 相关联的状态
用法
$ pulsar-admin functions putstate options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | Pulsar Function 的完全限定函数名称（FQFN） | |
—name | The name of a Pulsar Function | |
—namespace | The namespace of a Pulsar Function | |
—tenant | The tenant of a Pulsar Function | |
-s, —state | 需要被插入的 FunctionState |
trigger
Triggers the specified Pulsar Function with a supplied value
用法
$ pulsar-admin functions trigger options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—fqfn | 此 function 的完全限定名称（FQFN） | |
—name | Function 的名称 | |
—namespace | Function 的命名空间 | |
—tenant | Function 的租户 | |
—topic | 特定的主题名称，用户将数据注入到该主题 ，function 从该主题消费数据 | |
—trigger-file | 文件路径，该路径中包含你想触发 function 时需要的数据 | |
—trigger-value | 触发 function 时使用的值 |
functions-worker
收集 function-worker 统计数据的操作
$ pulsar-admin functions-worker subcommand
Subcommands
function-statsget-clusterget-cluster-leaderget-function-assignmentsmonitoring-metrics
function-stats
转储在此 broker 上运行的所有 function 的统计数据
用法
$ pulsar-admin functions-worker function-stats
get-cluster
获取属于此集群的所有 worker
用法
$ pulsar-admin functions-worker get-cluster
get-cluster-leader
获取 worker 集群的 leader
用法
$ pulsar-admin functions-worker get-cluster-leader
get-function-assignments
获取 function 在 worker 集群中的分配情况
用法
$ pulsar-admin functions-worker get-function-assignments
monitoring-metrics
转储用于监控的度量值
用法
$ pulsar-admin functions-worker monitoring-metrics
namespaces
Operations for managing namespaces
$ pulsar-admin namespaces subcommand
Subcommands
listtopicspoliciescreatedeleteset-deduplicationset-auto-topic-creationremove-auto-topic-creationset-auto-subscription-creationremove-auto-subscription-creationpermissionsgrant-permissionrevoke-permissiongrant-subscription-permissionrevoke-subscription-permissionset-clustersget-clustersget-backlog-quotasset-backlog-quotaremove-backlog-quotaget-persistenceset-persistenceget-message-ttlset-message-ttlremove-message-ttlget-anti-affinity-groupset-anti-affinity-groupget-anti-affinity-namespacesdelete-anti-affinity-groupget-retentionset-retentionunloadsplit-bundleset-dispatch-rateget-dispatch-rateset-replicator-dispatch-rateget-replicator-dispatch-rateset-subscribe-rateget-subscribe-rateset-subscription-dispatch-rateget-subscription-dispatch-rateclear-backlogunsubscribeset-encryption-requiredset-delayed-deliveryget-delayed-deliveryset-subscription-auth-modeget-max-producers-per-topicset-max-producers-per-topicget-max-consumers-per-topicset-max-consumers-per-topicget-max-consumers-per-subscriptionset-max-consumers-per-subscriptionget-max-unacked-messages-per-subscriptionset-max-unacked-messages-per-subscriptionget-max-unacked-messages-per-consumerset-max-unacked-messages-per-consumerget-compaction-thresholdset-compaction-thresholdget-offload-thresholdset-offload-thresholdget-offload-deletion-lagset-offload-deletion-lagclear-offload-deletion-lagget-schema-autoupdate-strategyset-schema-autoupdate-strategyset-offload-policiesget-offload-policiesset-max-subscriptions-per-topicget-max-subscriptions-per-topicremove-max-subscriptions-per-topic
list
Get the namespaces for a tenant
用法
$ pulsar-admin namespaces list tenant-name
topics
Get the list of topics for a namespace
用法
$ pulsar-admin namespaces topics tenant/namespace
policies
Get the configuration policies of a namespace
用法
$ pulsar-admin namespaces policies tenant/namespace
create
Create a new namespace
用法
$ pulsar-admin namespaces create tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-b, —bundles | 要激活的 bundle 数量 | 0 |
-c, —clusters | 将分配此命名空间的集群列表 |
delete
Deletes a namespace. The namespace needs to be empty
用法
$ pulsar-admin namespaces delete tenant/namespace
set-deduplication
Enable or disable message deduplication on a namespace
用法
$ pulsar-admin namespaces set-deduplication tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—enable, -e | 在指定的命名空间上启用删除重复消息 | false |
—disable, -d | 在指定的命名空间上禁用删除重复消息 | false |
set-auto-topic-creation
启用或禁用命名空间的 autoTopicCreation，覆盖 broker 设置
用法
$ pulsar-admin namespaces set-auto-topic-creation tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—enable, -e | 在命名空间上启用 allowAutoTopicCreation | false |
—disable, -d | 禁用命名空间上的 allowAutoTopicCreation | false |
—type, -t | Type of topic to be auto-created. Possible values: (partitioned, non-partitioned) | non-partitioned |
—num-partitions, -n | 要自动创建的主题的默认分区数，仅适用于分区主题 |
remove-auto-topic-creation
移除对命名空间 autoTopicCreation 的覆盖
用法
$ pulsar-admin namespaces remove-auto-topic-creation tenant/namespace
set-auto-subscription-creation
启用命名空间的 autoSubscriptionCreation，覆盖 broker 的设置
用法
$ pulsar-admin namespaces set-auto-subscription-creation tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—enable, -e | 在命名空间上启用 allowAutoSubscriptionCreation | false |
remove-auto-subscription-creation
用法
$ pulsar-admin namespaces remove-auto-subscription-creation tenant/namespace
permissions
Get the permissions on a namespace
用法
$ pulsar-admin namespaces permissions tenant/namespace
grant-permission
Grant permissions on a namespace
用法
$ pulsar-admin namespaces grant-permission tenant/namespace options
选项
revoke-permission
Revoke permissions on a namespace
用法
$ pulsar-admin namespaces revoke-permission tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—role | 要撤销权限的客户角色 |
grant-subscription-permission
Grant permissions to access subscription admin-api
用法
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—roles | 要授予权限的客户角色 (逗号分隔的角色) | |
—subscription | 将授予角色权限的订阅名称 |
revoke-subscription-permission
Revoke permissions to access subscription admin-api
用法
$ pulsar-admin namespaces revoke-subscription-permission tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—role | 要撤销权限的客户角色 | |
—subscription | 将撤销角色权限的订阅名称 |
Set replication clusters for a namespace
用法
$ pulsar-admin namespaces set-clusters tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-c, —clusters | Replication 集群的 ID 列表（逗号分支的值） |
get-clusters
Get replication clusters for a namespace
用法
$ pulsar-admin namespaces get-clusters tenant/namespace
get-backlog-quotas
Get the backlog quota policies for a namespace
用法
$ pulsar-admin namespaces get-backlog-quotas tenant/namespace
set-backlog-quota
Set a backlog quota policy for a namespace
用法
$ pulsar-admin namespaces set-backlog-quota tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-l, —limit | 积压的大小限制 (例如，10M 或 16G) | |
-p, —policy | The retention policy to enforce when the limit is reached. The valid options are: producer_request_hold, producer_exception or consumer_backlog_eviction |
示例
$ pulsar-admin namespaces set-backlog-quota my-tenant/my-ns \--limit 2G \--policy producer_request_hold
remove-backlog-quota
Remove a backlog quota policy from a namespace
用法
$ pulsar-admin namespaces remove-backlog-quota tenant/namespace
get-persistence
Get the persistence policies for a namespace
用法
$ pulsar-admin namespaces get-persistence tenant/namespace
set-persistence
Set the persistence policies for a namespace
用法
$ pulsar-admin namespaces set-persistence tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-a, —bookkeeper-ack-quorum | The number of acks (guaranteed copies) to wait for each entry | 0 |
-e, —bookkeeper-ensemble | The number of bookies to use for a topic | 0 |
-w, —bookkeeper-write-quorum | 每个 entry 要写入多少次 | 0 |
-r, —ml-mark-delete-max-rate | 标记删除操作的限流频率(0表示不限制) |
get-message-ttl
Get the message TTL for a namespace
用法
$ pulsar-admin namespaces get-message-ttl tenant/namespace
set-message-ttl
Set the message TTL for a namespace
用法
$ pulsar-admin namespaces set-message-ttl tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-ttl, —messageTTL | Message TTL in seconds. When the value is set to 0, TTL is disabled. TTL is disabled by default. | 0 |
remove-message-ttl
Remove the message TTL for a namespace.
用法
$ pulsar-admin namespaces remove-message-ttl tenant/namespace
get-anti-affinity-group
Get Anti-affinity group name for a namespace
用法
$ pulsar-admin namespaces get-anti-affinity-group tenant/namespace
set-anti-affinity-group
Set Anti-affinity group name for a namespace
用法
$ pulsar-admin namespaces set-anti-affinity-group tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-g, —group | Anti-affinity 组名 |
get-anti-affinity-namespaces
Get Anti-affinity namespaces grouped with the given anti-affinity group name
用法
$ pulsar-admin namespaces get-anti-affinity-namespaces options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-c, —cluster | 集群名称 | |
-g, —group | Anti-affinity 组名 | |
-p, —tenant | Tenant is only used for authorization. Client has to be admin of any of the tenant to access this api |
delete-anti-affinity-group
Remove Anti-affinity group name for a namespace
用法
$ pulsar-admin namespaces delete-anti-affinity-group tenant/namespace
get-retention
Get the retention policy that is applied to each topic within the specified namespace
用法
$ pulsar-admin namespaces get-retention tenant/namespace
set-retention
Set the retention policy for each topic within the specified namespace
用法
$ pulsar-admin namespaces set-retention tenant/namespace
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-s, —size | The retention size limits (for example 10M, 16G or 3T) for each topic in the namespace. 0 means no retention and -1 means infinite size retention | |
-t, —time | The retention time in minutes, hours, days, or weeks. Examples: 100m, 13h, 2d, 5w. 0 means no retention and -1 means infinite time retention |
unload
Unload a namespace or namespace bundle from the current serving broker.
用法
$ pulsar-admin namespaces unload tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-b, —bundle | {start-boundary}_{end-boundary} (例如，0x000000_0xffffffff) |
split-bundle
Split a namespace-bundle from the current serving broker
用法
$ pulsar-admin namespaces split-bundle tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-b, —bundle | {start-boundary}_{end-boundary} (例如，0x000000_0xffffffff) | |
-u, —unload | 拆分旧的 bundle 后卸载新切分的 bundle | false |
set-dispatch-rate
Set message-dispatch-rate for all topics of the namespace
用法
$ pulsar-admin namespaces set-dispatch-rate tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-bd, —byte-dispatch-rate | 字节派发速率(默认 -1， 如果不通过将被覆盖) | -1 |
-dt, —dispatch-rate-period | 以秒为单位的派发速率的周期（默认1秒，如果不通过将被覆盖） | 1 |
-md, —msg-dispatch-rate | 消息派发速率（默认 -1，如果不通过将被覆盖） | -1 |
get-dispatch-rate
Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)
用法
$ pulsar-admin namespaces get-dispatch-rate tenant/namespace
set-replicator-dispatch-rate
Set replicator message-dispatch-rate for all topics of the namespace
用法
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-bd, —byte-dispatch-rate | 字节派发速率(默认 -1， 如果不通过将被覆盖) | -1 |
-dt, —dispatch-rate-period | 以秒为单位的派发速率的周期（默认1秒，如果不通过将被覆盖） | 1 |
-md, —msg-dispatch-rate | 消息派发速率（默认 -1，如果不通过将被覆盖） | -1 |
get-replicator-dispatch-rate
Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)
用法
$ pulsar-admin namespaces get-replicator-dispatch-rate tenant/namespace
set-subscribe-rate
Set subscribe-rate per consumer for all topics of the namespace
用法
$ pulsar-admin namespaces set-subscribe-rate tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-sr, —subscribe-rate | 订阅速率（默认 -1， 如果不通过将被覆盖） | -1 |
-st, —subscribe-rate-period | 以秒为单位的订阅速率的周期（默认30秒，如果不通过将被覆盖） | 30 |
get-subscribe-rate
Get configured subscribe-rate per consumer for all topics of the namespace
用法
$ pulsar-admin namespaces get-subscribe-rate tenant/namespace
set-subscription-dispatch-rate
Set subscription message-dispatch-rate for all subscription of the namespace
用法
$ pulsar-admin namespaces set-subscription-dispatch-rate tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-bd, —byte-dispatch-rate | 字节派发速率(默认 -1， 如果不通过将被覆盖) | -1 |
-dt, —dispatch-rate-period | 以秒为单位的派发速率的周期（默认1秒，如果不通过将被覆盖） | 1 |
-md, —sub-msg-dispatch-rate | 消息派发速率（默认 -1，如果不通过将被覆盖） | -1 |
get-subscription-dispatch-rate
Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)
用法
$ pulsar-admin namespaces get-subscription-dispatch-rate tenant/namespace
clear-backlog
Clear the backlog for a namespace
用法
$ pulsar-admin namespaces clear-backlog tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-b, —bundle | {start-boundary}_{end-boundary} (例如，0x000000_0xffffffff) | |
-force, —force | 是否在没有提示的情况下强制清除积压数据 | false |
-s, —sub | 订阅名称 |
unsubscribe
Unsubscribe the given subscription on all destinations on a namespace
用法
$ pulsar-admin namespaces unsubscribe tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-b, —bundle | {start-boundary}_{end-boundary} (例如，0x000000_0xffffffff) | |
-s, —sub | 订阅名称 |
set-encryption-required
Enable or disable message encryption required for a namespace
用法
$ pulsar-admin namespaces set-encryption-required tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-d, —disable | 禁用需要的消息加密 | false |
-e, —enable | 启用需要的消息加密 | false |
set-delayed-delivery
在命名空间设置延迟传递策略
用法
$ pulsar-admin namespaces set-delayed-delivery tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-d, —disable | 禁用延迟传递消息 | false |
-e, —enable | 启用延迟传递消息 | false |
-t, —time | 延迟发送消息重试时的刻度时间 | 1s |
get-delayed-delivery
获取命名空间设置的延迟传递策略
用法
$ pulsar-admin namespaces get-delayed-delivery-time tenant/namespace
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-t, —time | 延迟发送消息重试时的刻度时间 | 1s |
set-subscription-auth-mode
Set subscription auth mode on a namespace
用法
$ pulsar-admin namespaces set-subscription-auth-mode tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-m, —subscription-auth-mode | Subscription authorization mode for Pulsar policies. Valid options are: [None, Prefix] |
get-max-producers-per-topic
Get maxProducersPerTopic for a namespace
用法
$ pulsar-admin namespaces get-max-producers-per-topic tenant/namespace
set-max-producers-per-topic
Set maxProducersPerTopic for a namespace
用法
$ pulsar-admin namespaces set-max-producers-per-topic tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-p, —max-producers-per-topic | 一个命名空间下每个主题的最大生产者数量 | 0 |
get-max-consumers-per-topic
Get maxConsumersPerTopic for a namespace
用法
$ pulsar-admin namespaces get-max-consumers-per-topic tenant/namespace
set-max-consumers-per-topic
Set maxConsumersPerTopic for a namespace
用法
$ pulsar-admin namespaces set-max-consumers-per-topic tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-c, —max-consumers-per-topic | 一个命名空间下每个主题的最大消费者数量 | 0 |
get-max-consumers-per-subscription
Get maxConsumersPerSubscription for a namespace
用法
$ pulsar-admin namespaces get-max-consumers-per-subscription tenant/namespace
set-max-consumers-per-subscription
Set maxConsumersPerSubscription for a namespace
用法
$ pulsar-admin namespaces set-max-consumers-per-subscription tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-c, —max-consumers-per-subscription | 一个命名空间下每个订阅的最大消费者数量 | 0 |
get-max-unacked-messages-per-subscription
获取命名空间的 maxUnackedMessagesPerSubscription
用法
$ pulsar-admin namespaces get-max-unacked-messages-per-subscription tenant/namespace
set-max-unacked-messages-per-subscription
设置命名空间的 maxUnackedMessagesPerSubscription
用法
$ pulsar-admin namespaces set-max-unacked-messages-per-subscription tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-c, —max-unacked-messages-per-subscription | 命名空间的 maxUnackedMessagesPerSubscription | -1 |
get-max-unacked-messages-per-consumer
获取命名空间的 maxUnackedMessagesPerConsumer
用法
$ pulsar-admin namespaces get-max-unacked-messages-per-consumer tenant/namespace
set-max-unacked-messages-per-consumer
设置命名空间的 maxUnackedMessagesPerConsumer
用法
$ pulsar-admin namespaces set-max-unacked-messages-per-consumer tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-c, —max-unacked-messages-per-consumer | 命名空间的 maxUnackedMessagesPerConsumer | -1 |
get-compaction-threshold
Get compactionThreshold for a namespace
用法
set-compaction-threshold
Set compactionThreshold for a namespace
用法
$ pulsar-admin namespaces set-compaction-threshold tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-t, —threshold | Maximum number of bytes in a topic backlog before compaction is triggered (eg: 10M, 16G, 3T). 0 disables automatic compaction | 0 |
get-offload-threshold
Get offloadThreshold for a namespace
用法
$ pulsar-admin namespaces get-offload-threshold tenant/namespace
set-offload-threshold
Set offloadThreshold for a namespace
用法
$ pulsar-admin namespaces set-offload-threshold tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-s, —size | 在数据开始自动卸载到持久化存储之前存储在 Pulsar 集群中的最大字节数，例如 10M。 负值标识禁用自动卸载。 0 值会触发尽快卸载。 | -1 |
get-offload-deletion-lag
Get offloadDeletionLag, in minutes, for a namespace
用法
$ pulsar-admin namespaces get-offload-deletion-lag tenant/namespace
set-offload-deletion-lag
Set offloadDeletionLag for a namespace
用法
$ pulsar-admin namespaces set-offload-deletion-lag tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-l, —lag | Duration to wait after offloading a ledger segment, before deleting the copy of that segment from cluster local storage. (eg: 10m, 5h, 3d, 2w). | -1 |
clear-offload-deletion-lag
Clear offloadDeletionLag for a namespace
用法
$ pulsar-admin namespaces clear-offload-deletion-lag tenant/namespace
get-schema-autoupdate-strategy
Get the schema auto-update strategy for a namespace
用法
$ pulsar-admin namespaces get-schema-autoupdate-strategy tenant/namespace
set-schema-autoupdate-strategy
Set the schema auto-update strategy for a namespace
用法
$ pulsar-admin namespaces set-schema-autoupdate-strategy tenant/namespace options
选项
get-publish-rate
获取命名空间中每个主题的消息发布频率，单位是字节以及消息每秒。
用法
$ pulsar-admin namespaces get-publish-rate tenant/namespace
set-publish-rate
设置命名空间中每个主题的消息发布频率
用法
$ pulsar-admin namespaces set-publish-rate tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-m, —msg-publish-rate | 命名空间中每个主题每秒的消息数量阈值(-1 表示未设置，0 表示无限制)。 | -1 |
-b, —byte-publish-rate | 命名空间中每个主题每秒的字节数量阈值(-1 表示未设置，0 表示无限制)。 | -1 |
set-offload-policies
Set the offload policy for a namespace.
用法
$ pulsar-admin namespaces set-offload-policies tenant/namespace options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-d, —driver | 用于卸载旧数据到长期存储的驱动程序,(可能值: S3, aws-s3, google-cloud-storage) | |
-r, —region | 长期储存区 | |
-b, —bucket | 将被卸载的 ledger 放入的 Bucket | |
-e, —endpoint | 可连接的替代端点 | |
-i, —aws-id | 使用 S3 或 aws-s3 驱动时使用的 AWS 凭据 id | |
-s, —aws-secret | 使用 S3 或 aws-s3 驱动时使用的 AWS 凭据 secret | |
-ro, —s3-role | S3 角色用于使用驱动 S3 或 aws-s3 的 STSAssumeRoleSessionCredentialsProvider | |
-rsn, —s3-role-session-name | S3 角色会话名称用于使用驱动 S3 或 aws-s3 的 STSAssumeRoleSessionCredentialsProvider | |
-mbs, —maxBlockSize | 最大块大小 | 64MB |
-rbs, —readBufferSize | 读缓冲大小 | 1MB |
-oat, —offloadAfterThreshold | 到阈值大小后卸载，（例如 1M、5M） | |
-oae, —offloadAfterElapsed | 以毫秒为单位的时间过去后卸载（或分钟、小时、天、星期，比如：100m, 3h, 2d, 52）。 |
get-offload-policies
Get the offload policy for a namespace.
用法
$ pulsar-admin namespaces get-offload-policies tenant/namespace
set-max-subscriptions-per-topic
Set the maximum subscription per topic for a namespace.
用法
$ pulsar-admin namespaces set-max-subscriptions-per-topic tenant/namespace
get-max-subscriptions-per-topic
Get the maximum subscription per topic for a namespace.
用法
$ pulsar-admin namespaces get-max-subscriptions-per-topic tenant/namespace
remove-max-subscriptions-per-topic
Remove the maximum subscription per topic for a namespace.
用法
$ pulsar-admin namespaces remove-max-subscriptions-per-topic tenant/namespace
Operations for managing namespace isolation policies.
用法
$ pulsar-admin ns-isolation-policy subcommand
Subcommands
setgetlistdeletebrokersbroker
set
Create/update a namespace isolation policy for a cluster. This operation requires Pulsar superuser privileges.
用法
$ pulsar-admin ns-isolation-policy set cluster-name policy-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—auto-failover-policy-params | 逗号分隔的 name=value 形式，用于自动灾备策略的参数 | [] |
—auto-failover-policy-type | Auto failover policy type name. Currently available options: min_available. | [] |
—namespaces | 逗号分隔的命名空间正则表达式列表 | [] |
—primary | 逗号分隔的主 broker 正则表达式列表 | [] |
—secondary | 逗号分隔的备用 broker 正则表达式列表 | [] |
get
Get the namespace isolation policy of a cluster. This operation requires Pulsar superuser privileges.
用法
$ pulsar-admin ns-isolation-policy get cluster-name policy-name
list
List all namespace isolation policies of a cluster. This operation requires Pulsar superuser privileges.
用法
$ pulsar-admin ns-isolation-policy list cluster-name
Delete namespace isolation policy of a cluster. This operation requires superuser privileges.
用法
$ pulsar-admin ns-isolation-policy delete
brokers
用法
broker
Get broker with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges.
用法
$ pulsar-admin ns-isolation-policy broker cluster-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—broker | 指定 borker 名称，用于以获取附加到它的命名空间隔离策略 |
topics
管理 Pulsar 主题 ( 持久和非持久) 的操作。
用法
$ pulsar-admin topics subcommand
从 Pulsar 2.7.0 开始，一些命名空间级别的策略在主题级别可用。 To enable topic-level policy in Pulsar, you need to configure the following parameters in the broker.conf file.
systemTopicEnabled=truetopicLevelPoliciesEnabled=true
Subcommands
compactcompaction-statusoffloadoffload-statuscreate-partitioned-topiccreate-missed-partitionsdelete-partitioned-topiccreateget-partitioned-topic-metadataupdate-partitioned-topiclist-partitioned-topicslistterminatepermissionsgrant-permissionrevoke-permissionlookupbundle-rangedeleteunloadcreate-subscriptionsubscriptionsunsubscribestatsstats-internalinfo-internalpartitioned-statspartitioned-stats-internalskipclear-backlogexpire-messagesexpire-messages-all-subscriptionspeek-messagesreset-cursorget-message-by-idlast-message-idget-backlog-quotasset-backlog-quotaremove-backlog-quotaget-persistenceset-persistenceremove-persistenceget-message-ttlset-message-ttlremove-message-ttlget-deduplicationset-deduplicationremove-deduplicationget-retentionset-retentionremove-retentionget-dispatch-rateset-dispatch-rateremove-dispatch-rateget-max-unacked-messages-per-subscriptionset-max-unacked-messages-per-subscriptionremove-max-unacked-messages-per-subscriptionget-max-unacked-messages-per-consumerset-max-unacked-messages-per-consumerremove-max-unacked-messages-per-consumerget-delayed-deliveryset-delayed-deliveryremove-delayed-deliveryget-max-producersset-max-producersremove-max-producersget-max-consumersset-max-consumersremove-max-consumersget-compaction-thresholdset-compaction-thresholdremove-compaction-thresholdget-offload-policiesset-offload-policiesremove-offload-policiesget-inactive-topic-policiesset-inactive-topic-policiesremove-inactive-topic-policiesset-max-subscriptionsget-max-subscriptionsremove-max-subscriptions
compact
Run compaction on the specified topic (persistent topics only)
用法
$ pulsar-admin topics compact persistent://tenant/namespace/topic
compaction-status
Check the status of a topic compaction (persistent topics only)
用法
$ pulsar-admin topics compaction-status persistent://tenant/namespace/topic
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-w, —wait-complete | 等待操作完成 | false |
offload
Trigger offload of data from a topic to long-term storage (e.g. Amazon S3)
用法
$ pulsar-admin topics offload persistent://tenant/namespace/topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-s, —size-threshold | 针对特定主题，设置在 Bookeeper 中保存的最大数据量 |
offload-status
Check the status of data offloading from a topic to long-term storage
用法
$ pulsar-admin topics offload-status persistent://tenant/namespace/topic op
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-w, —wait-complete | 等待操作完成 | false |
create-partitioned-topic
Create a partitioned topic. A partitioned topic must be created before producers can publish to it.
用法
$ pulsar-admin topics create-partitioned-topic {persistent|non-persistent}://tenant/namespace/topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-p, —partitions | 主题的分区数 | 0 |
create-missed-partitions
Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled
用法
$ pulsar-admin topics create-missed-partitions persistent://tenant/namespace/topic
delete-partitioned-topic
Delete a partitioned topic. This will also delete all the partitions of the topic if they exist.
用法
$ pulsar-admin topics delete-partitioned-topic {persistent|non-persistent}
create
Creates a non-partitioned topic. A non-partitioned topic must explicitly be created by the user if allowAutoTopicCreation or createIfMissing is disabled.
用法
$ pulsar-admin topics create {persistent|non-persistent}://tenant/namespace/topic
get-partitioned-topic-metadata
Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, this will return an empty topic with zero partitions.
用法
$ pulsar-admin topics get-partitioned-topic-metadata {persistent|non-persistent}://tenant/namespace/topic
update-partitioned-topic
Update existing non-global partitioned topic. New updating number of partitions must be greater than existing number of partitions.
用法
$ pulsar-admin topics update-partitioned-topic {persistent|non-persistent}://tenant/namespace/topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-p, —partitions | 主题的分区数 | 0 |
list-partitioned-topics
获取命名空间下的分区主题列表。
用法
$ pulsar-admin topics list-partitioned-topics tenant/namespace
list
Get the list of topics under a namespace
用法
$ pulsar-admin topics list tenant/cluster/namespace
terminate
终止一个持久化的主题 (不允许再在该主题上发布更多消息)
用法
$ pulsar-admin topics terminate persistent://tenant/namespace/topic
permissions
Get the permissions on a topic. 获取目标的有效权限。 These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permissions set on the topic.
用法
$ pulsar-admin topics permissions topic
grant-permission
Grant a new permission to a client role on a single topic
用法
$ pulsar-admin topics grant-permission {persistent|non-persistent}://tenant/namespace/topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—actions | 要授权的操作(produce 或 consume) | |
—role | 要授予权限的客户角色 |
revoke-permission
Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412).
用法
$ pulsar-admin topics revoke-permission topic
lookup
Look up a topic from the current serving broker
用法
$ pulsar-admin topics lookup topic
bundle-range
Get the namespace bundle which contains the given topic
用法
$ pulsar-admin topics bundle-range topic
delete
Delete a topic. The topic cannot be deleted if there are any active subscriptions or producers connected to the topic.
用法
$ pulsar-admin topics delete topic
unload
Unload a topic
用法
$ pulsar-admin topics unload topic
create-subscription
在主题上创建新的订阅。
用法
$ pulsar-admin topics create-subscription [options] persistent://tenant/namespace/topic
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-m, —messageId | messageId where to create the subscription. It can be either ‘latest’, ‘earliest’ or (ledgerId:entryId) | latest |
-s, —subscription | 设置订阅的名称，在该订阅上重置订阅位置 |
subscriptions
Get the list of subscriptions on the topic
用法
$ pulsar-admin topics subscriptions topic
unsubscribe
Delete a durable subscriber from a topic
用法
$ pulsar-admin topics unsubscribe topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-s, —subscription | 要删除的订阅 | |
-f, —force | 断开和关闭所有消费者并强制删除订阅 | false |
stats
Get the stats for the topic and its connected producers and consumers. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period.
用法
$ pulsar-admin topics stats topic
stats-internal
Get the internal stats for the topic
用法
$ pulsar-admin topics stats-internal topic
info-internal
Get the internal metadata info for the topic
用法
$ pulsar-admin topics info-internal topic
partitioned-stats
Get the stats for the partitioned topic and its connected producers and consumers. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period.
用法
$ pulsar-admin topics partitioned-stats topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—per-partition | 获取每个分区的统计数据 | false |
partitioned-stats-internal
Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
用法
$ pulsar-admin topics partitioned-stats-internal topic
skip
Skip some messages for the subscription
用法
$ pulsar-admin topics skip topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-n, —count | 设置要跳过的消息数量 | 0 |
-s, —subscription | 设置订阅的名称，在该订阅上跳过消息 |
clear-backlog
清除订阅的积压（跳过所有消息）
用法
$ pulsar-admin topics clear-backlog topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-s, —subscription | 要清除数据的订阅 |
expire-messages
Expire messages that are older than the given expiry time (in seconds) for the subscription.
用法
$ pulsar-admin topics expire-messages topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-t, —expireTime | 过期消息超过时间(秒) | 0 |
-s, —subscription | 设置订阅的名称，在该订阅上跳过消息 |
expire-messages-all-subscriptions
Expire messages older than the given expiry time (in seconds) for all subscriptions
用法
$ pulsar-admin topics expire-messages-all-subscriptions topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-t, —expireTime | 过期消息超过时间(秒) | 0 |
peek-messages
Peek some messages for the subscription.
用法
$ pulsar-admin topics peek-messages topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-n, —count | 消息数量 | 0 |
-s, —subscription | 订阅的名称，从该订阅获取消息 |
reset-cursor
重置订阅的位置到离时间戳或 messageID 最近的位置。
用法
$ pulsar-admin topics reset-cursor topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-s, —subscription | 设置订阅的名称，在该订阅上重置订阅位置 | |
-t, —time | The time in minutes to reset back to (or minutes, hours, days, weeks, etc.). Examples: 100m, 3h, 2d, 5w. | |
-m, —messageId | The messageId to reset back to (ledgerId:entryId). |
get-message-by-id
通过 ledger id 和 entry id 获取消息
用法
$ pulsar-admin topics get-message-by-id topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-l, —ledgerId | ledger id | 0 |
-e, —entryId | entry id | 0 |
last-message-id
Get the last commit message ID of the topic.
用法
$ pulsar-admin topics last-message-id persistent://tenant/namespace/topic
get-backlog-quotas
Get the backlog quota policies for a topic.
用法
$ pulsar-admin topics get-backlog-quotas tenant/namespace/topic
set-backlog-quota
Set a backlog quota policy for a topic.
用法
$ pulsar-admin topics set-backlog-quota tenant/namespace/topic options
remove-backlog-quota
Remove a backlog quota policy from a topic.
用法
$ pulsar-admin topics remove-backlog-quota tenant/namespace/topic
get-persistence
Get the persistence policies for a topic.
用法
$ pulsar-admin topics get-persistence tenant/namespace/topic
set-persistence
Set the persistence policies for a topic.
用法
$ pulsar-admin topics set-persistence tenant/namespace/topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-e, —bookkeeper-ensemble | 主题使用的的 bookie 数量 | 0 |
-w, —bookkeeper-write-quorum | 每个 entry 要写入多少次 | 0 |
-a, —bookkeeper-ack-quorum | 每个 entry 等待的 ack 数 (保证副本) | 0 |
-r, —ml-mark-delete-max-rate | 标记删除操作的限流频率(0表示不限制) |
remove-persistence
Remove the persistence policy for a topic.
用法
$ pulsar-admin topics remove-persistence tenant/namespace/topic
get-message-ttl
Get the message TTL for a topic.
用法
$ pulsar-admin topics get-message-ttl tenant/namespace/topic
set-message-ttl
Set the message TTL for a topic.
用法
$ pulsar-admin topics set-message-ttl tenant/namespace/topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-ttl, —messageTTL | 主题消息的 TTL，以秒为单位，允许从 1 到 Integer.MAX_VALUE | 0 |
remove-message-ttl
Remove the message TTL for a topic.
用法
$ pulsar-admin topics remove-message-ttl tenant/namespace/topic
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—enable, -e | Enable message deduplication on the specified topic. | false |
—disable, -d | Disable message deduplication on the specified topic. | false |
get-deduplication
Get a deduplication policy for a topic.
用法
$ pulsar-admin topics get-deduplication tenant/namespace/topic
set-deduplication
Set a deduplication policy for a topic.
用法
$ pulsar-admin topics set-deduplication tenant/namespace/topic options
remove-deduplication
Remove a deduplication policy for a topic.
用法
$ pulsar-admin topics remove-deduplication tenant/namespace/topic
tenants
Operations for managing tenants
用法
$ pulsar-admin tenants subcommand
Subcommands
listgetcreateupdatedelete
list
List the existing tenants
用法
$ pulsar-admin tenants list
get
Gets the configuration of a tenant
用法
$ pulsar-admin tenants get tenant-name
create
Creates a new tenant
用法
$ pulsar-admin tenants create tenant-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-r, —admin-roles | 逗号分隔的管理员角色 | |
-c, —allowed-clusters | 逗号分隔的允许集群 |
update
Updates a tenant
用法
$ pulsar-admin tenants update tenant-name options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-r, —admin-roles | 逗号分隔的管理员角色 | |
-c, —allowed-clusters | 逗号分隔的允许集群 |
delete
Deletes an existing tenant
用法
$ pulsar-admin tenants delete tenant-name
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-f, —force | 通过删除租户下的所有命名空间来强制删除租户 | false |
Operations for managing resource quotas
用法
$ pulsar-admin resource-quotas subcommand
Subcommands
getsetreset-namespace-bundle-quota
get
Get the resource quota for a specified namespace bundle, or default quota if no namespace/bundle is specified.
用法
$ pulsar-admin resource-quotas get options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-b, —bundle | A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/—namespace. | |
-n, —namespace | 命名空间 |
set
Set the resource quota for the specified namespace bundle, or default quota if no namespace/bundle is specified.
用法
$ pulsar-admin resource-quotas set options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-bi, —bandwidthIn | 期望配置的入站带宽（字节/秒） | 0 |
-bo, —bandwidthOut | 期望配置的出站带宽（字节/秒） | |
-b, —bundle | A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/—namespace. | |
-d, —dynamic | 启用动态重新计算（或禁用） | false |
-mem, —memory | 期望配置的内存使用量（以兆字节为单位） | 0 |
-mi, —msgRateIn | 期望配置的每秒接收消息数量 | 0 |
-mo, —msgRateOut | 期望配置的每秒发送消息数量 | 0 |
-n, —namespace | The namespace as tenant/namespace, for example my-tenant/my-ns. Must be specified together with -b/—bundle. |
reset-namespace-bundle-quota
重置指定的命名空间包的资源配额为默认值。
用法
$ pulsar-admin resource-quotas reset-namespace-bundle-quota options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-b, —bundle | A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/—namespace. | |
-n, —namespace | 命名空间 |
schemas
Operations related to Schemas associated with Pulsar topics.
用法
$ pulsar-admin schemas subcommand
Subcommands
uploaddeletegetextract
upload
Upload the schema definition for a topic
用法
$ pulsar-admin schemas upload persistent://tenant/namespace/topic options
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
—filename | The path to the schema definition file. An example schema file is available under conf directory. |
delete
Delete the schema definition associated with a topic
用法
$ pulsar-admin schemas delete persistent://tenant/namespace/topic
Retrieve the schema definition associated with a topic (at a given version if version is supplied).
用法
选项
extract
Provide the schema definition for a topic via Java class name contained in a JAR file
选项
| 标记 | 说明 | 默认值 |
|---|---|---|
-c, —classname | Java 类名称 | |
-j, —jar | 包含 Java 类的 JAR 文件路径 | |
, —type | Schema 的类型（avro or json） |
