This provides the REST API for admin operations
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: v2
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optionalPut the package under your project folder and add the following in import:
import "./openapi"All URIs are relative to http://localhost/admin/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BookiesApi | DeleteBookieRackInfo | Delete /bookies/racks-info/{bookie} | Removed the rack placement information for a specific bookie in the cluster |
| BookiesApi | GetBookieRackInfo | Get /bookies/racks-info/{bookie} | Gets the rack placement information for a specific bookie in the cluster |
| BookiesApi | GetBookiesRackInfo | Get /bookies/racks-info | Gets the rack placement information for all the bookies in the cluster |
| BookiesApi | UpdateBookieRackInfo | Post /bookies/racks-info/{bookie} | Updates the rack placement information for a specific bookie in the cluster |
| BrokerStatsApi | GetAllocatorStats | Get /broker-stats/allocator-stats/{allocator} | Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache' |
| BrokerStatsApi | GetBrokerResourceAvailability | Get /broker-stats/broker-resource-availability/{tenant}/{namespace} | Broker availability report |
| BrokerStatsApi | GetLoadReport | Get /broker-stats/load-report | Get Load for this broker |
| BrokerStatsApi | GetMBeans | Get /broker-stats/mbeans | Get all the mbean details of this broker JVM |
| BrokerStatsApi | GetMetrics | Get /broker-stats/metrics | Gets the metrics for Monitoring |
| BrokerStatsApi | GetPendingBookieOpsStats | Get /broker-stats/bookieops | Get pending bookie client op stats by namesapce |
| BrokerStatsApi | GetTopics2 | Get /broker-stats/topics | Get all the topic stats by namespace |
| BrokersApi | DeleteDynamicConfiguration | Delete /brokers/configuration/{configName} | Delete dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges. |
| BrokersApi | GetActiveBrokers | Get /brokers/{cluster} | Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid. |
| BrokersApi | GetAllDynamicConfigurations | Get /brokers/configuration/values | Get value of all dynamic configurations' value overridden on local config |
| BrokersApi | GetDynamicConfigurationName | Get /brokers/configuration | Get all updatable dynamic configurations's name |
| BrokersApi | GetInternalConfigurationData | Get /brokers/internal-configuration | Get the internal configuration data |
| BrokersApi | GetOwnedNamespaes | Get /brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces | Get the list of namespaces served by the specific broker |
| BrokersApi | GetRuntimeConfiguration | Get /brokers/configuration/runtime | Get all runtime configurations. This operation requires Pulsar super-user privileges. |
| BrokersApi | Healthcheck | Get /brokers/health | Run a healthcheck against the broker |
| BrokersApi | UpdateDynamicConfiguration | Post /brokers/configuration/{configName}/{configValue} | Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges. |
| ClustersApi | CreateCluster | Put /clusters/{cluster} | Create a new cluster. |
| ClustersApi | DeleteCluster | Delete /clusters/{cluster} | Delete an existing cluster. |
| ClustersApi | DeleteFailureDomain | Delete /clusters/{cluster}/failureDomains/{domainName} | Delete the failure domain of the cluster |
| ClustersApi | DeleteNamespaceIsolationPolicy | Delete /clusters/{cluster}/namespaceIsolationPolicies/{policyName} | Delete namespace isolation policy. |
| ClustersApi | GetBrokerWithNamespaceIsolationPolicy | Get /clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker} | Get a broker with namespace-isolation policies attached to it. |
| ClustersApi | GetBrokersWithNamespaceIsolationPolicy | Get /clusters/{cluster}/namespaceIsolationPolicies/brokers | Get list of brokers with namespace-isolation policies attached to them. |
| ClustersApi | GetCluster | Get /clusters/{cluster} | Get the configuration for the specified cluster. |
| ClustersApi | GetClusters | Get /clusters | Get the list of all the Pulsar clusters. |
| ClustersApi | GetDomain | Get /clusters/{cluster}/failureDomains/{domainName} | Get a domain in a cluster |
| ClustersApi | GetFailureDomains | Get /clusters/{cluster}/failureDomains | Get the cluster failure domains. |
| ClustersApi | GetNamespaceIsolationPolicies | Get /clusters/{cluster}/namespaceIsolationPolicies | Get the namespace isolation policies assigned to the cluster. |
| ClustersApi | GetNamespaceIsolationPolicy | Get /clusters/{cluster}/namespaceIsolationPolicies/{policyName} | Get the single namespace isolation policy assigned to the cluster. |
| ClustersApi | GetPeerCluster | Get /clusters/{cluster}/peers | Get the peer-cluster data for the specified cluster. |
| ClustersApi | SetFailureDomain | Post /clusters/{cluster}/failureDomains/{domainName} | Set the failure domain of the cluster. |
| ClustersApi | SetNamespaceIsolationPolicy | Post /clusters/{cluster}/namespaceIsolationPolicies/{policyName} | Set namespace isolation policy. |
| ClustersApi | SetPeerClusterNames | Post /clusters/{cluster}/peers | Update peer-cluster-list for a cluster. |
| ClustersApi | UpdateCluster | Post /clusters/{cluster} | Update the configuration for a cluster. |
| NamespacesApi | ClearNamespaceBacklog | Post /namespaces/{tenant}/{namespace}/clearBacklog | Clear backlog for all topics on a namespace. |
| NamespacesApi | ClearNamespaceBacklogForSubscription | Post /namespaces/{tenant}/{namespace}/clearBacklog/{subscription} | Clear backlog for a given subscription on all topics on a namespace. |
| NamespacesApi | ClearNamespaceBundleBacklog | Post /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog | Clear backlog for all topics on a namespace bundle. |
| NamespacesApi | ClearNamespaceBundleBacklogForSubscription | Post /namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription} | Clear backlog for a given subscription on all topics on a namespace bundle. |
| NamespacesApi | ClearOffloadDeletionLag | Delete /namespaces/{tenant}/{namespace}/offloadDeletionLagMs | Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker |
| NamespacesApi | CreateNamespace | Put /namespaces/{tenant}/{namespace} | Creates a new namespace with the specified policies |
| NamespacesApi | DeleteBookieAffinityGroup | Delete /namespaces/{property}/{namespace}/persistence/bookieAffinity | Delete the bookie-affinity-group from namespace-local policy. |
| NamespacesApi | DeleteNamespace | Delete /namespaces/{tenant}/{namespace} | Delete a namespace and all the topics under it. |
| NamespacesApi | DeleteNamespaceBundle | Delete /namespaces/{tenant}/{namespace}/{bundle} | Delete a namespace bundle and all the topics under it. |
| NamespacesApi | GetAntiAffinityNamespaces | Get /namespaces/{cluster}/antiAffinity/{group} | Get all namespaces that are grouped by given anti-affinity group in a given cluster. api can be only accessed by admin of any of the existing tenant |
| NamespacesApi | GetBacklogQuotaMap | Get /namespaces/{tenant}/{namespace}/backlogQuotaMap | Get backlog quota map on a namespace. |
| NamespacesApi | GetBookieAffinityGroup | Get /namespaces/{property}/{namespace}/persistence/bookieAffinity | Get the bookie-affinity-group from namespace-local policy. |
| NamespacesApi | GetBundlesData | Get /namespaces/{tenant}/{namespace}/bundles | Get the bundles split data. |
| NamespacesApi | GetCompactionThreshold | Get /namespaces/{tenant}/{namespace}/compactionThreshold | Maximum number of uncompacted bytes in topics before compaction is triggered. |
| NamespacesApi | GetDispatchRate | Get /namespaces/{tenant}/{namespace}/dispatchRate | Get dispatch-rate configured for the namespace, -1 represents not configured yet |
| NamespacesApi | GetMaxConsumersPerSubscription | Get /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription | Get maxConsumersPerSubscription config on a namespace. |
| NamespacesApi | GetMaxConsumersPerTopic | Get /namespaces/{tenant}/{namespace}/maxConsumersPerTopic | Get maxConsumersPerTopic config on a namespace. |
| NamespacesApi | GetMaxProducersPerTopic | Get /namespaces/{tenant}/{namespace}/maxProducersPerTopic | Get maxProducersPerTopic config on a namespace. |
| NamespacesApi | GetNamespaceAntiAffinityGroup | Get /namespaces/{tenant}/{namespace}/antiAffinity | Get anti-affinity group of a namespace. |
| NamespacesApi | GetNamespaceMessageTTL | Get /namespaces/{tenant}/{namespace}/messageTTL | Get the message TTL for the namespace |
| NamespacesApi | GetNamespaceReplicationClusters | Get /namespaces/{tenant}/{namespace}/replication | Get the replication clusters for a namespace. |
| NamespacesApi | GetOffloadDeletionLag | Get /namespaces/{tenant}/{namespace}/offloadDeletionLagMs | Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) |
| NamespacesApi | GetOffloadThreshold | Get /namespaces/{tenant}/{namespace}/offloadThreshold | Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage |
| NamespacesApi | GetPermissions | Get /namespaces/{tenant}/{namespace}/permissions | Retrieve the permissions for a namespace. |
| NamespacesApi | GetPersistence | Get /namespaces/{tenant}/{namespace}/persistence | Get the persistence configuration for a namespace. |
| NamespacesApi | GetPolicies | Get /namespaces/{tenant}/{namespace} | Get the dump all the policies specified for a namespace. |
| NamespacesApi | GetReplicatorDispatchRate | Get /namespaces/{tenant}/{namespace}/replicatorDispatchRate | Get replicator dispatch-rate configured for the namespace, -1 represents not configured yet |
| NamespacesApi | GetRetention | Get /namespaces/{tenant}/{namespace}/retention | Get retention config on a namespace. |
| NamespacesApi | GetSchemaAutoUpdateCompatibilityStrategy | Get /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy | The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema |
| NamespacesApi | GetSchemaValidtionEnforced | Get /namespaces/{tenant}/{namespace}/schemaValidationEnforced | Get schema validation enforced flag for namespace. |
| NamespacesApi | GetSubscribeRate | Get /namespaces/{tenant}/{namespace}/subscribeRate | Get subscribe-rate configured for the namespace |
| NamespacesApi | GetSubscriptionDispatchRate | Get /namespaces/{tenant}/{namespace}/subscriptionDispatchRate | Get Subscription dispatch-rate configured for the namespace, -1 represents not configured yet |
| NamespacesApi | GetTenantNamespaces | Get /namespaces/{tenant} | Get the list of all the namespaces for a certain tenant. |
| NamespacesApi | GetTopics | Get /namespaces/{tenant}/{namespace}/topics | Get the list of all the topics under a certain namespace. |
| NamespacesApi | GrantPermissionOnNamespace | Post /namespaces/{tenant}/{namespace}/permissions/{role} | Grant a new permission to a role on a namespace. |
| NamespacesApi | ModifyDeduplication | Post /namespaces/{tenant}/{namespace}/deduplication | Enable or disable broker side deduplication for all topics in a namespace |
| NamespacesApi | ModifyEncryptionRequired | Post /namespaces/{tenant}/{namespace}/encryptionRequired | Message encryption is required or not for all topics in a namespace |
| NamespacesApi | RemoveBacklogQuota | Delete /namespaces/{tenant}/{namespace}/backlogQuota | Remove a backlog quota policy from a namespace. |
| NamespacesApi | RemoveNamespaceAntiAffinityGroup | Delete /namespaces/{tenant}/{namespace}/antiAffinity | Remove anti-affinity group of a namespace. |
| NamespacesApi | RevokePermissionsOnNamespace | Delete /namespaces/{tenant}/{namespace}/permissions/{role} | Revoke all permissions to a role on a namespace. |
| NamespacesApi | SetBacklogQuota | Post /namespaces/{tenant}/{namespace}/backlogQuota | Set a backlog quota for all the topics on a namespace. |
| NamespacesApi | SetBookieAffinityGroup | Post /namespaces/{tenant}/{namespace}/persistence/bookieAffinity | Set the bookie-affinity-group to namespace-persistent policy. |
| NamespacesApi | SetCompactionThreshold | Put /namespaces/{tenant}/{namespace}/compactionThreshold | Set maximum number of uncompacted bytes in a topic before compaction is triggered. |
| NamespacesApi | SetDispatchRate | Post /namespaces/{tenant}/{namespace}/dispatchRate | Set dispatch-rate throttling for all topics of the namespace |
| NamespacesApi | SetMaxConsumersPerSubscription | Post /namespaces/{tenant}/{namespace}/maxConsumersPerSubscription | Set maxConsumersPerSubscription configuration on a namespace. |
| NamespacesApi | SetMaxConsumersPerTopic | Post /namespaces/{tenant}/{namespace}/maxConsumersPerTopic | Set maxConsumersPerTopic configuration on a namespace. |
| NamespacesApi | SetMaxProducersPerTopic | Post /namespaces/{tenant}/{namespace}/maxProducersPerTopic | Set maxProducersPerTopic configuration on a namespace. |
| NamespacesApi | SetNamespaceAntiAffinityGroup | Post /namespaces/{tenant}/{namespace}/antiAffinity | Set anti-affinity group for a namespace |
| NamespacesApi | SetNamespaceMessageTTL | Post /namespaces/{tenant}/{namespace}/messageTTL | Set message TTL in seconds for namespace |
| NamespacesApi | SetNamespaceReplicationClusters | Post /namespaces/{tenant}/{namespace}/replication | Set the replication clusters for a namespace. |
| NamespacesApi | SetOffloadDeletionLag | Put /namespaces/{tenant}/{namespace}/offloadDeletionLagMs | Set number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper) |
| NamespacesApi | SetOffloadThreshold | Put /namespaces/{tenant}/{namespace}/offloadThreshold | Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage |
| NamespacesApi | SetPersistence | Post /namespaces/{tenant}/{namespace}/persistence | Set the persistence configuration for all the topics on a namespace. |
| NamespacesApi | SetReplicatorDispatchRate | Post /namespaces/{tenant}/{namespace}/replicatorDispatchRate | Set replicator dispatch-rate throttling for all topics of the namespace |
| NamespacesApi | SetRetention | Post /namespaces/{tenant}/{namespace}/retention | Set retention configuration on a namespace. |
| NamespacesApi | SetSchemaAutoUpdateCompatibilityStrategy | Put /namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy | Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema |
| NamespacesApi | SetSchemaValidtionEnforced | Post /namespaces/{tenant}/{namespace}/schemaValidationEnforced | Set schema validation enforced flag on namespace. |
| NamespacesApi | SetSubscribeRate | Post /namespaces/{tenant}/{namespace}/subscribeRate | Set subscribe-rate throttling for all topics of the namespace |
| NamespacesApi | SetSubscriptionAuthMode | Post /namespaces/{tenant}/{namespace}/subscriptionAuthMode | Set a subscription auth mode for all the topics on a namespace. |
| NamespacesApi | SetSubscriptionDispatchRate | Post /namespaces/{tenant}/{namespace}/subscriptionDispatchRate | Set Subscription dispatch-rate throttling for all topics of the namespace |
| NamespacesApi | SplitNamespaceBundle | Put /namespaces/{tenant}/{namespace}/{bundle}/split | Split a namespace bundle |
| NamespacesApi | UnloadNamespace | Put /namespaces/{tenant}/{namespace}/unload | Unload namespace |
| NamespacesApi | UnloadNamespaceBundle | Put /namespaces/{tenant}/{namespace}/{bundle}/unload | Unload a namespace bundle |
| NamespacesApi | UnsubscribeNamespace | Post /namespaces/{tenant}/{namespace}/unsubscribe/{subscription} | Unsubscribes the given subscription on all topics on a namespace. |
| NamespacesApi | UnsubscribeNamespaceBundle | Post /namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription} | Unsubscribes the given subscription on all topics on a namespace bundle. |
| NonPersistentTopicApi | Compact | Put /non-persistent/{tenant}/{namespace}/{topic}/compaction | Trigger a compaction operation on a topic. |
| NonPersistentTopicApi | CompactionStatus | Get /non-persistent/{tenant}/{namespace}/{topic}/compaction | Get the status of a compaction operation for a topic. |
| NonPersistentTopicApi | CreateNonPartitionedTopic | Put /non-persistent/{tenant}/{namespace}/{topic} | Create a non-partitioned topic. |
| NonPersistentTopicApi | CreatePartitionedTopic | Put /non-persistent/{tenant}/{namespace}/{topic}/partitions | Create a partitioned topic. |
| NonPersistentTopicApi | CreateSubscription | Put /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} | Reset subscription to message position closest to given position. |
| NonPersistentTopicApi | DeletePartitionedTopic | Delete /non-persistent/{tenant}/{namespace}/{topic}/partitions | Delete a partitioned topic. |
| NonPersistentTopicApi | DeleteSubscription | Delete /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName} | Delete a subscription. |
| NonPersistentTopicApi | DeleteTopic | Delete /non-persistent/{tenant}/{namespace}/{topic} | Delete a topic. |
| NonPersistentTopicApi | ExpireMessagesForAllSubscriptions | Post /non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} | Expiry messages on all subscriptions of topic. |
| NonPersistentTopicApi | ExpireTopicMessages | Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} | Expiry messages on a topic subscription. |
| NonPersistentTopicApi | GetBacklog | Get /non-persistent/{tenant}/{namespace}/{topic}/backlog | Get estimated backlog for offline topic. |
| NonPersistentTopicApi | GetInternalStats | Get /non-persistent/{tenant}/{namespace}/{topic}/internalStats | Get the internal stats for the topic. |
| NonPersistentTopicApi | GetLastMessageId | Get /non-persistent/{tenant}/{namespace}/{topic}/lastMessageId | Return the last commit message id of topic |
| NonPersistentTopicApi | GetList | Get /non-persistent/{tenant}/{namespace} | Get the list of non-persistent topics under a namespace. |
| NonPersistentTopicApi | GetListFromBundle | Get /non-persistent/{tenant}/{namespace}/{bundle} | Get the list of non-persistent topics under a namespace bundle. |
| NonPersistentTopicApi | GetManagedLedgerInfo | Get /non-persistent/{tenant}/{namespace}/{topic}/internal-info | Get the internal stats for the topic. |
| NonPersistentTopicApi | GetPartitionedMetadata | Get /non-persistent/{tenant}/{namespace}/{topic}/partitions | Get partitioned topic metadata. |
| NonPersistentTopicApi | GetPartitionedStats | Get /non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats | Get the stats for the partitioned topic. |
| NonPersistentTopicApi | GetPartitionedTopicList | Get /non-persistent/{tenant}/{namespace}/partitioned | Get the list of partitioned topics under a namespace. |
| NonPersistentTopicApi | GetPermissionsOnTopic | Get /non-persistent/{tenant}/{namespace}/{topic}/permissions | Get permissions on a topic. |
| NonPersistentTopicApi | GetStats | Get /non-persistent/{tenant}/{namespace}/{topic}/stats | Get the stats for the topic. |
| NonPersistentTopicApi | GetSubscriptions | Get /non-persistent/{tenant}/{namespace}/{topic}/subscriptions | Get the list of persistent subscriptions for a given topic. |
| NonPersistentTopicApi | GrantPermissionsOnTopic | Post /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Grant a new permission to a role on a single topic. |
| NonPersistentTopicApi | OffloadStatus | Get /non-persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage |
| NonPersistentTopicApi | PeekNthMessage | Get /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} | Peek nth message on a topic subscription. |
| NonPersistentTopicApi | ResetCursor | Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} | Reset subscription to message position closest to absolute timestamp (in ms). |
| NonPersistentTopicApi | ResetCursorOnPosition | Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor | Reset subscription to message position closest to given position. |
| NonPersistentTopicApi | RevokePermissionsOnTopic | Delete /non-persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Revoke permissions on a topic. |
| NonPersistentTopicApi | SkipAllMessages | Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all | Skip all messages on a topic subscription. |
| NonPersistentTopicApi | SkipMessages | Post /non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} | Skipping messages on a topic subscription. |
| NonPersistentTopicApi | Terminate | Post /non-persistent/{tenant}/{namespace}/{topic}/terminate | Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog |
| NonPersistentTopicApi | TriggerOffload | Put /non-persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage |
| NonPersistentTopicApi | UnloadTopic | Put /non-persistent/{tenant}/{namespace}/{topic}/unload | Unload a topic |
| NonPersistentTopicApi | UpdatePartitionedTopic | Post /non-persistent/{tenant}/{namespace}/{topic}/partitions | Increment partitons of an existing partitioned topic. |
| PersistentTopicApi | Compact | Put /persistent/{tenant}/{namespace}/{topic}/compaction | Trigger a compaction operation on a topic. |
| PersistentTopicApi | CompactionStatus | Get /persistent/{tenant}/{namespace}/{topic}/compaction | Get the status of a compaction operation for a topic. |
| PersistentTopicApi | CreateNonPartitionedTopic | Put /persistent/{tenant}/{namespace}/{topic} | Create a non-partitioned topic. |
| PersistentTopicApi | CreatePartitionedTopic | Put /persistent/{tenant}/{namespace}/{topic}/partitions | Create a partitioned topic. |
| PersistentTopicApi | CreateSubscription | Put /persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName} | Reset subscription to message position closest to given position. |
| PersistentTopicApi | DeletePartitionedTopic | Delete /persistent/{tenant}/{namespace}/{topic}/partitions | Delete a partitioned topic. |
| PersistentTopicApi | DeleteSubscription | Delete /persistent/{tenant}/{namespace}/{topic}/subscription/{subName} | Delete a subscription. |
| PersistentTopicApi | DeleteTopic | Delete /persistent/{tenant}/{namespace}/{topic} | Delete a topic. |
| PersistentTopicApi | ExpireMessagesForAllSubscriptions | Post /persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds} | Expiry messages on all subscriptions of topic. |
| PersistentTopicApi | ExpireTopicMessages | Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds} | Expiry messages on a topic subscription. |
| PersistentTopicApi | GetBacklog | Get /persistent/{tenant}/{namespace}/{topic}/backlog | Get estimated backlog for offline topic. |
| PersistentTopicApi | GetInternalStats | Get /persistent/{tenant}/{namespace}/{topic}/internalStats | Get the internal stats for the topic. |
| PersistentTopicApi | GetLastMessageId | Get /persistent/{tenant}/{namespace}/{topic}/lastMessageId | Return the last commit message id of topic |
| PersistentTopicApi | GetList | Get /persistent/{tenant}/{namespace} | Get the list of topics under a namespace. |
| PersistentTopicApi | GetManagedLedgerInfo | Get /persistent/{tenant}/{namespace}/{topic}/internal-info | Get the internal stats for the topic. |
| PersistentTopicApi | GetPartitionedMetadata | Get /persistent/{tenant}/{namespace}/{topic}/partitions | Get partitioned topic metadata. |
| PersistentTopicApi | GetPartitionedStats | Get /persistent/{tenant}/{namespace}/{topic}/partitioned-stats | Get the stats for the partitioned topic. |
| PersistentTopicApi | GetPartitionedTopicList | Get /persistent/{tenant}/{namespace}/partitioned | Get the list of partitioned topics under a namespace. |
| PersistentTopicApi | GetPermissionsOnTopic | Get /persistent/{tenant}/{namespace}/{topic}/permissions | Get permissions on a topic. |
| PersistentTopicApi | GetStats | Get /persistent/{tenant}/{namespace}/{topic}/stats | Get the stats for the topic. |
| PersistentTopicApi | GetSubscriptions | Get /persistent/{tenant}/{namespace}/{topic}/subscriptions | Get the list of persistent subscriptions for a given topic. |
| PersistentTopicApi | GrantPermissionsOnTopic | Post /persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Grant a new permission to a role on a single topic. |
| PersistentTopicApi | OffloadStatus | Get /persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage |
| PersistentTopicApi | PeekNthMessage | Get /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition} | Peek nth message on a topic subscription. |
| PersistentTopicApi | ResetCursor | Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp} | Reset subscription to message position closest to absolute timestamp (in ms). |
| PersistentTopicApi | ResetCursorOnPosition | Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor | Reset subscription to message position closest to given position. |
| PersistentTopicApi | RevokePermissionsOnTopic | Delete /persistent/{tenant}/{namespace}/{topic}/permissions/{role} | Revoke permissions on a topic. |
| PersistentTopicApi | SkipAllMessages | Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all | Skip all messages on a topic subscription. |
| PersistentTopicApi | SkipMessages | Post /persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages} | Skipping messages on a topic subscription. |
| PersistentTopicApi | Terminate | Post /persistent/{tenant}/{namespace}/{topic}/terminate | Terminate a topic. A topic that is terminated will not accept any more messages to be published and will let consumer to drain existing messages in backlog |
| PersistentTopicApi | TriggerOffload | Put /persistent/{tenant}/{namespace}/{topic}/offload | Offload a prefix of a topic to long term storage |
| PersistentTopicApi | UnloadTopic | Put /persistent/{tenant}/{namespace}/{topic}/unload | Unload a topic |
| PersistentTopicApi | UpdatePartitionedTopic | Post /persistent/{tenant}/{namespace}/{topic}/partitions | Increment partitons of an existing partitioned topic. |
| ResourceQuotasApi | GetDefaultResourceQuota | Get /resource-quotas | Get the default quota |
| ResourceQuotasApi | GetNamespaceBundleResourceQuota | Get /resource-quotas/{tenant}/{namespace}/{bundle} | Get resource quota of a namespace bundle. |
| ResourceQuotasApi | RemoveNamespaceBundleResourceQuota | Delete /resource-quotas/{tenant}/{namespace}/{bundle} | Remove resource quota for a namespace. |
| ResourceQuotasApi | SetDefaultResourceQuota | Post /resource-quotas | Set the default quota |
| ResourceQuotasApi | SetNamespaceBundleResourceQuota | Post /resource-quotas/{tenant}/{namespace}/{bundle} | Set resource quota on a namespace. |
| SchemasApi | DeleteSchema | Delete /schemas/{tenant}/{namespace}/{topic}/schema | Delete the schema of a topic |
| SchemasApi | GetAllSchemas | Get /schemas/{tenant}/{namespace}/{topic}/schemas | Get the all schemas of a topic |
| SchemasApi | GetSchema | Get /schemas/{tenant}/{namespace}/{topic}/schema | Get the schema of a topic |
| SchemasApi | GetSchema_0 | Get /schemas/{tenant}/{namespace}/{topic}/schema/{version} | Get the schema of a topic at a given version |
| SchemasApi | GetVersionBySchema | Post /schemas/{tenant}/{namespace}/{topic}/version | get the version of the schema |
| SchemasApi | PostSchema | Post /schemas/{tenant}/{namespace}/{topic}/schema | Update the schema of a topic |
| SchemasApi | TestCompatibility | Post /schemas/{tenant}/{namespace}/{topic}/compatibility | test the schema compatibility |
| TenantsApi | CreateTenant | Put /tenants/{tenant} | Create a new tenant. |
| TenantsApi | DeleteTenant | Delete /tenants/{tenant} | Delete a tenant and all namespaces and topics under it. |
| TenantsApi | GetTenantAdmin | Get /tenants/{tenant} | Get the admin configuration for a given tenant. |
| TenantsApi | GetTenants | Get /tenants | Get the list of existing tenants. |
| TenantsApi | UpdateTenant | Post /tenants/{tenant} | Update the admins for a tenant. |
- AllocatorStats
- AuthPolicies
- AutoFailoverPolicyData
- BacklogQuota
- BookieAffinityGroupData
- BookieInfo
- BrokerNamespaceIsolationData
- BundlesData
- ClusterData
- ConsumerStats
- CursorDetails
- CursorStats
- DeleteSchemaResponse
- DispatchRate
- FailureDomain
- GetAllVersionsSchemaResponse
- GetSchemaResponse
- InternalConfigurationData
- IsCompatibilityResponse
- LedgerDetails
- LedgerInfo
- LoadReport
- LongRunningProcessStatus
- LongSchemaVersion
- MessageIdImpl
- Metrics
- NamespaceBundleStats
- NamespaceIsolationData
- NamespaceOwnershipStatus
- NonPersistentPublisherStats
- NonPersistentReplicatorStats
- NonPersistentSubscriptionStats
- NonPersistentTopicStats
- OffloadProcessStatus
- PartitionedTopicMetadata
- PendingBookieOpsStats
- PersistencePolicies
- PersistentOfflineTopicStats
- PersistentTopicInternalStats
- Policies
- PoolArenaStats
- PoolChunkListStats
- PoolChunkStats
- PoolSubpageStats
- PostSchemaPayload
- PostSchemaResponse
- PublisherStats
- ReplicatorStats
- ResourceDescription
- ResourceQuota
- ResourceUnit
- ResourceUsage
- RetentionPolicies
- SubscribeRate
- SubscriptionStats
- SystemResourceUsage
- TenantInfo
- TopicStats
Endpoints do not require authorization.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent