{ "components": { "schemas": { "AllocatorStats": { "properties": { "directArenas": { "items": { "$ref": "#/components/schemas/PoolArenaStats" }, "type": "array" }, "heapArenas": { "items": { "$ref": "#/components/schemas/PoolArenaStats" }, "type": "array" }, "normalCacheSize": { "format": "int32", "type": "integer" }, "numDirectArenas": { "format": "int32", "type": "integer" }, "numHeapArenas": { "format": "int32", "type": "integer" }, "numThreadLocalCaches": { "format": "int32", "type": "integer" }, "smallCacheSize": { "format": "int32", "type": "integer" }, "usedDirectMemory": { "format": "int64", "type": "integer" }, "usedHeapMemory": { "format": "int64", "type": "integer" } }, "type": "object" }, "AuthPolicies": { "properties": { "namespaceAuthentication": { "additionalProperties": { "items": { "enum": [ "produce", "consume", "functions", "sources", "sinks", "packages" ], "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" }, "subscriptionAuthentication": { "additionalProperties": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" }, "topicAuthentication": { "additionalProperties": { "additionalProperties": { "items": { "enum": [ "produce", "consume", "functions", "sources", "sinks", "packages" ], "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" }, "type": "object" } }, "type": "object" }, "AutoFailoverPolicyData": { "description": "The data of auto-failover policy configuration", "example": { "parameters": { "": "" }, "policy_type": "min_available" }, "properties": { "parameters": { "additionalProperties": { "type": "string" }, "type": "object" }, "policyType": { "enum": [ "min_available" ], "type": "string" } }, "type": "object" }, "AutoScalePolicyOverride": { "properties": { "enabled": { "type": "boolean" }, "maxDagDepth": { "format": "int32", "type": "integer" }, "maxSegments": { "format": "int32", "type": "integer" }, "mergeBytesRateInThreshold": { "format": "int64", "type": "integer" }, "mergeBytesRateOutThreshold": { "format": "int64", "type": "integer" }, "mergeCooldownSeconds": { "format": "int64", "type": "integer" }, "mergeMsgRateInThreshold": { "format": "double", "type": "number" }, "mergeMsgRateOutThreshold": { "format": "double", "type": "number" }, "mergeWindowSeconds": { "format": "int64", "type": "integer" }, "minSegments": { "format": "int32", "type": "integer" }, "splitBytesRateInThreshold": { "format": "int64", "type": "integer" }, "splitBytesRateOutThreshold": { "format": "int64", "type": "integer" }, "splitCooldownSeconds": { "format": "int64", "type": "integer" }, "splitMsgRateInThreshold": { "format": "double", "type": "number" }, "splitMsgRateOutThreshold": { "format": "double", "type": "number" } }, "type": "object" }, "AutoSubscriptionCreationOverride": { "properties": { "allowAutoSubscriptionCreation": { "type": "boolean" } }, "type": "object" }, "AutoSubscriptionCreationOverrideImpl": { "properties": { "allowAutoSubscriptionCreation": { "type": "boolean" } }, "type": "object" }, "AutoTopicCreationOverride": { "properties": { "allowAutoTopicCreation": { "type": "boolean" }, "defaultNumPartitions": { "format": "int32", "type": "integer" }, "topicType": { "type": "string" } }, "type": "object" }, "AutoTopicCreationOverrideImpl": { "properties": { "allowAutoTopicCreation": { "type": "boolean" }, "defaultNumPartitions": { "format": "int32", "type": "integer" }, "topicType": { "type": "string" } }, "type": "object" }, "BacklogQuota": { "properties": { "limit": { "format": "int64", "type": "integer" }, "limitSize": { "format": "int64", "type": "integer" }, "limitTime": { "format": "int32", "type": "integer" }, "policy": { "enum": [ "producer_request_hold", "producer_exception", "consumer_backlog_eviction" ], "type": "string" } }, "type": "object" }, "BacklogQuotaImpl": { "properties": { "limit": { "format": "int64", "type": "integer" }, "limitSize": { "format": "int64", "type": "integer" }, "limitTime": { "format": "int32", "type": "integer" }, "policy": { "enum": [ "producer_request_hold", "producer_exception", "consumer_backlog_eviction" ], "type": "string" } }, "type": "object" }, "BookieAffinityGroupData": { "properties": { "bookkeeperAffinityGroupPrimary": { "type": "string" }, "bookkeeperAffinityGroupSecondary": { "type": "string" } }, "type": "object" }, "BookieAffinityGroupDataImpl": { "properties": { "bookkeeperAffinityGroupPrimary": { "type": "string" }, "bookkeeperAffinityGroupSecondary": { "type": "string" } }, "type": "object" }, "BookieInfo": { "properties": { "hostname": { "type": "string" }, "rack": { "type": "string" } }, "type": "object" }, "BookiesClusterInfo": { "properties": { "bookies": { "items": { "$ref": "#/components/schemas/RawBookieInfo" }, "type": "array" } }, "type": "object" }, "BookiesRackConfiguration": { "properties": { "empty": { "type": "boolean" } }, "type": "object" }, "BrokerInfo": { "properties": { "brokerId": { "type": "string" }, "serviceUrl": { "type": "string" } }, "type": "object" }, "BrokerNamespaceIsolationData": { "description": "The namespace isolation data for a given broker", "properties": { "brokerName": { "description": "The broker name", "example": "broker1:8080", "type": "string" }, "namespaceRegex": { "description": "The namespace-isolation policies attached to this broker", "items": { "description": "The namespace-isolation policies attached to this broker", "type": "string" }, "type": "array" }, "policyName": { "description": "Policy name", "example": "my-policy", "type": "string" }, "primary": { "type": "boolean" } }, "type": "object" }, "BundlesData": { "properties": { "boundaries": { "items": { "type": "string" }, "type": "array" }, "numBundles": { "format": "int32", "type": "integer" } }, "type": "object" }, "BundlesDataImpl": { "properties": { "boundaries": { "items": { "type": "string" }, "type": "array" }, "numBundles": { "format": "int32", "type": "integer" } }, "type": "object" }, "ClusterData": { "description": "The configuration data for a cluster", "properties": { "authenticationParameters": { "description": "Authentication parameters when client would like to connect to cluster.", "type": "string" }, "authenticationPlugin": { "description": "Authentication plugin when client would like to connect to cluster.", "example": "org.apache.pulsar.client.impl.auth.AuthenticationToken", "type": "string" }, "brokerClientCertificateFilePath": { "description": "TLS certificate file for internal client, used by the internal client to authenticate with Pulsar brokers", "type": "string" }, "brokerClientKeyFilePath": { "description": "TLS private key file for internal client, used by the internal client to authenticate with Pulsar brokers", "type": "string" }, "brokerClientSslFactoryPlugin": { "description": "SSL Factory plugin used by internal client to generate the SSL Context and Engine", "type": "string" }, "brokerClientSslFactoryPluginParams": { "description": "Parameters used by the internal client's SSL factory plugin to generate the SSL Context and Engine", "type": "string" }, "brokerClientTlsEnabled": { "description": "Enable TLS when talking with other brokers in the same cluster (admin operation) or different clusters (replication)", "type": "boolean" }, "brokerClientTlsEnabledWithKeyStore": { "description": "Whether the internal client uses KeyStore type to authenticate with other Pulsar brokers", "type": "boolean" }, "brokerClientTlsKeyStore": { "description": "TLS KeyStore path for internal client, used by the internal client to authenticate with Pulsar brokers", "type": "string" }, "brokerClientTlsKeyStorePassword": { "description": "TLS KeyStore password for internal client, used by the internal client to authenticate with Pulsar brokers", "type": "string" }, "brokerClientTlsKeyStoreType": { "description": "TLS KeyStore type configuration for internal client: JKS, PKCS12, used by the internal client to authenticate with Pulsar brokers", "type": "string" }, "brokerClientTlsTrustStore": { "description": "TLS TrustStore path for internal client used by the internal client to authenticate with Pulsar brokers", "type": "string" }, "brokerClientTlsTrustStorePassword": { "description": "TLS TrustStore password for internal client used by the internal client to authenticate with Pulsar brokers", "type": "string" }, "brokerClientTlsTrustStoreType": { "description": "TLS TrustStore type configuration for internal client: JKS, PKCS12 used by the internal client to authenticate with Pulsar brokers", "example": "JKS", "type": "string" }, "brokerClientTrustCertsFilePath": { "description": "Path for the trusted TLS certificate file for outgoing connection to a server (broker)", "type": "string" }, "brokerServiceUrl": { "description": "The broker service url (for produce and consume operations)", "example": "pulsar://pulsar.example.com:6650", "type": "string" }, "brokerServiceUrlTls": { "description": "The secured broker service url (for produce and consume operations)", "example": "pulsar+ssl://pulsar.example.com:6651", "type": "string" }, "listenerName": { "description": "listenerName when client would like to connect to cluster", "type": "string" }, "peerClusterNames": { "description": "A set of peer cluster names", "items": { "description": "A set of peer cluster names", "type": "string" }, "type": "array" }, "proxyProtocol": { "description": "Protocol to decide the type of proxy routing, e.g. SNI-routing", "enum": [ "SNI" ], "example": "SNI", "type": "string" }, "proxyServiceUrl": { "description": "Proxy-service url when client would like to connect to broker via proxy.", "example": "pulsar+ssl://ats-proxy.example.com:4443 or pulsar://ats-proxy.example.com:4080", "type": "string" }, "serviceUrl": { "description": "The HTTP rest service URL (for admin operations)", "example": "http://pulsar.example.com:8080", "type": "string" }, "serviceUrlTls": { "description": "The HTTPS rest service URL (for admin operations)", "example": "https://pulsar.example.com:8443", "type": "string" }, "tlsAllowInsecureConnection": { "description": "Allow TLS connections to servers whose certificate cannot be verified to have been signed by a trusted certificate authority.", "type": "boolean" } }, "type": "object" }, "ClusterUrl": { "properties": { "brokerServiceUrl": { "type": "string" }, "brokerServiceUrlTls": { "type": "string" }, "empty": { "type": "boolean" }, "serviceUrl": { "type": "string" }, "serviceUrlTls": { "type": "string" } }, "type": "object" }, "CompactionStats": { "properties": { "lastCompactionDurationTimeInMills": { "format": "int64", "type": "integer" }, "lastCompactionFailedTimestamp": { "format": "int64", "type": "integer" }, "lastCompactionRemovedEventCount": { "format": "int64", "type": "integer" }, "lastCompactionSucceedTimestamp": { "format": "int64", "type": "integer" } }, "type": "object" }, "CompactionStatsImpl": { "properties": { "lastCompactionDurationTimeInMills": { "format": "int64", "type": "integer" }, "lastCompactionFailedTimestamp": { "format": "int64", "type": "integer" }, "lastCompactionRemovedEventCount": { "format": "int64", "type": "integer" }, "lastCompactionSucceedTimestamp": { "format": "int64", "type": "integer" } }, "type": "object" }, "ConnectorDefinition": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "sinkClass": { "type": "string" }, "sinkConfigClass": { "type": "string" }, "sourceClass": { "type": "string" }, "sourceConfigClass": { "type": "string" } }, "type": "object" }, "ConsumerStats": { "properties": { "address": { "type": "string" }, "appId": { "type": "string" }, "availablePermits": { "format": "int32", "type": "integer" }, "avgMessagesPerEntry": { "format": "int32", "type": "integer" }, "blockedConsumerOnUnackedMsgs": { "type": "boolean" }, "bytesOutCounter": { "format": "int64", "type": "integer" }, "chunkedMessageRate": { "format": "double", "type": "number" }, "clientVersion": { "type": "string" }, "connectedSince": { "type": "string" }, "consumerName": { "type": "string" }, "drainingHashes": { "items": { "$ref": "#/components/schemas/DrainingHash" }, "type": "array" }, "drainingHashesClearedTotal": { "format": "int64", "type": "integer" }, "drainingHashesCount": { "format": "int32", "type": "integer" }, "drainingHashesUnackedMessages": { "format": "int32", "type": "integer" }, "firstConsumedFlowTimestamp": { "format": "int64", "type": "integer" }, "firstMessagesSentTimestamp": { "format": "int64", "type": "integer" }, "keyHashRangeArrays": { "items": { "items": { "format": "int32", "type": "integer" }, "type": "array" }, "type": "array" }, "keyHashRanges": { "items": { "type": "string" }, "type": "array" }, "lastAckedTimestamp": { "format": "int64", "type": "integer" }, "lastConsumedFlowTimestamp": { "format": "int64", "type": "integer" }, "lastConsumedTimestamp": { "format": "int64", "type": "integer" }, "messageAckRate": { "format": "double", "type": "number" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "msgOutCounter": { "format": "int64", "type": "integer" }, "msgRateOut": { "format": "double", "type": "number" }, "msgRateRedeliver": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "readPositionWhenJoining": { "type": "string" }, "unackedMessages": { "format": "int32", "type": "integer" } }, "type": "object" }, "CursorDetails": { "properties": { "cursorBacklog": { "format": "int64", "type": "integer" }, "cursorLedgerId": { "format": "int64", "type": "integer" } }, "type": "object" }, "CursorInfo": { "properties": { "creationDate": { "type": "string" }, "cursorsLedgerId": { "format": "int64", "type": "integer" }, "individualDeletedMessages": { "items": { "$ref": "#/components/schemas/MessageRangeInfo" }, "type": "array" }, "markDelete": { "$ref": "#/components/schemas/PositionInfo" }, "modificationDate": { "type": "string" }, "properties": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" }, "version": { "format": "int64", "type": "integer" } }, "type": "object" }, "CursorStats": { "properties": { "active": { "type": "boolean" }, "cursorLedger": { "format": "int64", "type": "integer" }, "cursorLedgerLastEntry": { "format": "int64", "type": "integer" }, "individuallyDeletedMessages": { "type": "string" }, "lastLedgerSwitchTimestamp": { "type": "string" }, "markDeletePosition": { "type": "string" }, "messagesConsumedCounter": { "format": "int64", "type": "integer" }, "numberOfEntriesSinceFirstNotAckedMessage": { "format": "int64", "type": "integer" }, "pendingReadOps": { "format": "int32", "type": "integer" }, "properties": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" }, "readPosition": { "type": "string" }, "state": { "type": "string" }, "subscriptionHavePendingRead": { "type": "boolean" }, "subscriptionHavePendingReplayRead": { "type": "boolean" }, "totalNonContiguousDeletedMessagesRange": { "format": "int32", "type": "integer" }, "waitingReadOp": { "type": "boolean" } }, "type": "object" }, "DelayedDeliveryPolicies": { "properties": { "active": { "type": "boolean" }, "maxDeliveryDelayInMillis": { "format": "int64", "type": "integer" }, "tickTime": { "format": "int64", "type": "integer" } }, "type": "object" }, "DeleteSchemaResponse": { "properties": { "version": { "format": "int64", "type": "integer" } }, "type": "object" }, "DispatchRate": { "properties": { "dispatchThrottlingRateInByte": { "format": "int64", "type": "integer" }, "dispatchThrottlingRateInMsg": { "format": "int32", "type": "integer" }, "ratePeriodInSecond": { "format": "int32", "type": "integer" }, "relativeToPublishRate": { "type": "boolean" } }, "type": "object" }, "DispatchRateImpl": { "properties": { "dispatchThrottlingRateInByte": { "format": "int64", "type": "integer" }, "dispatchThrottlingRateInMsg": { "format": "int32", "type": "integer" }, "ratePeriodInSecond": { "format": "int32", "type": "integer" }, "relativeToPublishRate": { "type": "boolean" } }, "type": "object" }, "DrainingHash": { "properties": { "blockedAttempts": { "format": "int32", "type": "integer" }, "hash": { "format": "int32", "type": "integer" }, "unackMsgs": { "format": "int32", "type": "integer" } }, "type": "object" }, "EntryFilters": { "properties": { "entryFilterNames": { "type": "string" } }, "type": "object" }, "FailureDomain": { "description": "The data of a failure domain configuration in a cluster", "properties": { "brokers": { "description": "The collection of brokers in the same failure domain", "example": "[ 'broker-1', 'broker-2' ]", "items": { "description": "The collection of brokers in the same failure domain", "example": "[ 'broker-1', 'broker-2' ]", "type": "string" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "FunctionInstanceStatsData": { "properties": { "avgProcessLatency": { "format": "double", "type": "number" }, "lastInvocation": { "format": "int64", "type": "integer" }, "oneMin": { "$ref": "#/components/schemas/FunctionInstanceStatsDataBase" }, "processedSuccessfullyTotal": { "format": "int64", "type": "integer" }, "receivedTotal": { "format": "int64", "type": "integer" }, "systemExceptionsTotal": { "format": "int64", "type": "integer" }, "userExceptionsTotal": { "format": "int64", "type": "integer" }, "userMetrics": { "additionalProperties": { "format": "double", "type": "number" }, "type": "object" } }, "type": "object" }, "FunctionInstanceStatsDataBase": { "properties": { "avgProcessLatency": { "format": "double", "type": "number" }, "processedSuccessfullyTotal": { "format": "int64", "type": "integer" }, "receivedTotal": { "format": "int64", "type": "integer" }, "systemExceptionsTotal": { "format": "int64", "type": "integer" }, "userExceptionsTotal": { "format": "int64", "type": "integer" } }, "type": "object" }, "GetAllVersionsSchemaResponse": { "properties": { "getSchemaResponses": { "items": { "$ref": "#/components/schemas/GetSchemaResponse" }, "type": "array" } }, "type": "object" }, "GetSchemaResponse": { "properties": { "data": { "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "timestamp": { "format": "int64", "type": "integer" }, "type": { "enum": [ "NONE", "STRING", "JSON", "PROTOBUF", "AVRO", "BOOLEAN", "INT8", "INT16", "INT32", "INT64", "FLOAT", "DOUBLE", "DATE", "TIME", "TIMESTAMP", "KEY_VALUE", "INSTANT", "LOCAL_DATE", "LOCAL_TIME", "LOCAL_DATE_TIME", "PROTOBUF_NATIVE", "EXTERNAL", "BYTES", "AUTO", "AUTO_CONSUME", "AUTO_PUBLISH" ], "type": "string" }, "version": { "format": "int64", "type": "integer" } }, "type": "object" }, "GrantTopicPermissionOptions": { "properties": { "actions": { "items": { "enum": [ "produce", "consume", "functions", "sources", "sinks", "packages" ], "type": "string" }, "type": "array", "uniqueItems": true }, "role": { "type": "string" }, "topic": { "type": "string" } }, "type": "object" }, "HashRange": { "properties": { "end": { "format": "int32", "type": "integer" }, "start": { "format": "int32", "type": "integer" } }, "type": "object" }, "InactiveTopicPolicies": { "properties": { "deleteWhileInactive": { "type": "boolean" }, "inactiveTopicDeleteMode": { "enum": [ "delete_when_no_subscriptions", "delete_when_subscriptions_caught_up" ], "type": "string" }, "maxInactiveDurationSeconds": { "format": "int32", "type": "integer" } }, "type": "object" }, "InternalConfigurationData": { "properties": { "bookkeeperMetadataServiceUri": { "type": "string" }, "configurationMetadataStoreUrl": { "type": "string" }, "configurationStoreServers": { "type": "string" }, "ledgersRootPath": { "type": "string" }, "metadataStoreUrl": { "type": "string" }, "stateStorageServiceUrl": { "type": "string" }, "zookeeperServers": { "type": "string" } }, "type": "object" }, "IsCompatibilityResponse": { "properties": { "compatibility": { "type": "boolean" }, "schemaCompatibilityStrategy": { "type": "string" } }, "type": "object" }, "LedgerDetails": { "properties": { "entries": { "format": "int64", "type": "integer" }, "ledgerId": { "format": "int64", "type": "integer" }, "size": { "format": "int64", "type": "integer" }, "timestamp": { "format": "int64", "type": "integer" } }, "type": "object" }, "LedgerInfo": { "properties": { "entries": { "format": "int64", "type": "integer" }, "ledgerId": { "format": "int64", "type": "integer" }, "metadata": { "type": "string" }, "offloaded": { "type": "boolean" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "size": { "format": "int64", "type": "integer" }, "underReplicated": { "type": "boolean" } }, "type": "object" }, "LoadManagerReport": { "properties": { "bandwidthIn": { "$ref": "#/components/schemas/ResourceUsage" }, "bandwidthOut": { "$ref": "#/components/schemas/ResourceUsage" }, "brokerId": { "type": "string" }, "brokerVersionString": { "type": "string" }, "bundleStats": { "additionalProperties": { "$ref": "#/components/schemas/NamespaceBundleStats" }, "type": "object" }, "cpu": { "$ref": "#/components/schemas/ResourceUsage" }, "directMemory": { "$ref": "#/components/schemas/ResourceUsage" }, "lastUpdate": { "format": "int64", "type": "integer" }, "loadManagerClassName": { "type": "string" }, "memory": { "$ref": "#/components/schemas/ResourceUsage" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "nonPersistentTopicsEnabled": { "type": "boolean" }, "numBundles": { "format": "int32", "type": "integer" }, "numConsumers": { "format": "int32", "type": "integer" }, "numProducers": { "format": "int32", "type": "integer" }, "numTopics": { "format": "int64", "type": "integer" }, "persistentTopicsEnabled": { "type": "boolean" }, "protocols": { "additionalProperties": { "type": "string" }, "type": "object" }, "pulsarServiceUrl": { "type": "string" }, "pulsarServiceUrlTls": { "type": "string" }, "startTimestamp": { "format": "int64", "type": "integer" }, "webServiceUrl": { "type": "string" }, "webServiceUrlTls": { "type": "string" } }, "type": "object" }, "LoadReport": { "properties": { "allocatedBandwidthIn": { "format": "double", "type": "number" }, "allocatedBandwidthOut": { "format": "double", "type": "number" }, "allocatedCPU": { "format": "double", "type": "number" }, "allocatedMemory": { "format": "double", "type": "number" }, "allocatedMsgRateIn": { "format": "double", "type": "number" }, "allocatedMsgRateOut": { "format": "double", "type": "number" }, "bandwidthIn": { "$ref": "#/components/schemas/ResourceUsage" }, "bandwidthOut": { "$ref": "#/components/schemas/ResourceUsage" }, "brokerVersionString": { "type": "string" }, "bundleGains": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "bundleLosses": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "bundleStats": { "additionalProperties": { "$ref": "#/components/schemas/NamespaceBundleStats" }, "type": "object" }, "cpu": { "$ref": "#/components/schemas/ResourceUsage" }, "directMemory": { "$ref": "#/components/schemas/ResourceUsage" }, "lastUpdate": { "format": "int64", "type": "integer" }, "loadManagerClassName": { "type": "string" }, "loadReportType": { "type": "string" }, "memory": { "$ref": "#/components/schemas/ResourceUsage" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "name": { "type": "string" }, "nonPersistentTopicsEnabled": { "type": "boolean" }, "numBundles": { "format": "int32", "type": "integer" }, "numConsumers": { "format": "int32", "type": "integer" }, "numProducers": { "format": "int32", "type": "integer" }, "numTopics": { "format": "int64", "type": "integer" }, "overLoaded": { "type": "boolean" }, "persistentTopicsEnabled": { "type": "boolean" }, "preAllocatedBandwidthIn": { "format": "double", "type": "number" }, "preAllocatedBandwidthOut": { "format": "double", "type": "number" }, "preAllocatedCPU": { "format": "double", "type": "number" }, "preAllocatedMemory": { "format": "double", "type": "number" }, "preAllocatedMsgRateIn": { "format": "double", "type": "number" }, "preAllocatedMsgRateOut": { "format": "double", "type": "number" }, "protocols": { "additionalProperties": { "type": "string" }, "type": "object" }, "pulsarServiceUrl": { "type": "string" }, "pulsarServiceUrlTls": { "type": "string" }, "startTimestamp": { "format": "int64", "type": "integer" }, "systemResourceUsage": { "$ref": "#/components/schemas/SystemResourceUsage" }, "timestamp": { "format": "int64", "type": "integer" }, "underLoaded": { "type": "boolean" }, "webServiceUrl": { "type": "string" }, "webServiceUrlTls": { "type": "string" } }, "type": "object" }, "LongRunningProcessStatus": { "properties": { "lastError": { "type": "string" }, "status": { "enum": [ "NOT_RUN", "RUNNING", "SUCCESS", "ERROR" ], "type": "string" } }, "type": "object" }, "LongSchemaVersion": { "properties": { "version": { "format": "int64", "type": "integer" } }, "type": "object" }, "ManagedLedgerInfo": { "properties": { "creationDate": { "type": "string" }, "cursors": { "additionalProperties": { "$ref": "#/components/schemas/CursorInfo" }, "type": "object" }, "ledgers": { "items": { "$ref": "#/components/schemas/LedgerInfo" }, "type": "array" }, "modificationDate": { "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "terminatedPosition": { "$ref": "#/components/schemas/PositionInfo" }, "version": { "format": "int64", "type": "integer" } }, "type": "object" }, "MessageId": { "type": "object" }, "MessageIdAdv": { "properties": { "ackSet": { "properties": { "empty": { "type": "boolean" } }, "type": "object" }, "batchIndex": { "format": "int32", "type": "integer" }, "batchSize": { "format": "int32", "type": "integer" }, "entryId": { "format": "int64", "type": "integer" }, "firstChunkMessageId": { "$ref": "#/components/schemas/MessageIdAdv" }, "ledgerId": { "format": "int64", "type": "integer" }, "partitionIndex": { "format": "int32", "type": "integer" } }, "type": "object" }, "MessageIdImpl": { "properties": { "ackSet": { "properties": { "empty": { "type": "boolean" } }, "type": "object" }, "batchIndex": { "format": "int32", "type": "integer" }, "batchSize": { "format": "int32", "type": "integer" }, "entryId": { "format": "int64", "type": "integer" }, "firstChunkMessageId": { "$ref": "#/components/schemas/MessageIdAdv" }, "ledgerId": { "format": "int64", "type": "integer" }, "partitionIndex": { "format": "int32", "type": "integer" }, "tracingSpan": { "$ref": "#/components/schemas/Span" } }, "type": "object" }, "MessageRangeInfo": { "properties": { "from": { "$ref": "#/components/schemas/PositionInfo" }, "to": { "$ref": "#/components/schemas/PositionInfo" } }, "type": "object" }, "Metrics": { "properties": { "dimensions": { "additionalProperties": { "type": "string" }, "type": "object" }, "metrics": { "additionalProperties": { "type": "object" }, "type": "object" } }, "type": "object" }, "MigrationState": { "properties": { "phase": { "enum": [ "NOT_STARTED", "PREPARATION", "COPYING", "COMPLETED", "FAILED" ], "type": "string" }, "targetUrl": { "type": "string" } }, "type": "object" }, "NamespaceBundleStats": { "properties": { "cacheSize": { "format": "int64", "type": "integer" }, "consumerCount": { "format": "int32", "type": "integer" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "producerCount": { "format": "int32", "type": "integer" }, "topics": { "format": "int64", "type": "integer" } }, "type": "object" }, "NamespaceIsolationData": { "description": "The data of namespace isolation configuration", "properties": { "auto_failover_policy": { "$ref": "#/components/schemas/AutoFailoverPolicyData" }, "namespaces": { "description": "The list of namespaces to apply this namespace isolation data", "items": { "description": "The list of namespaces to apply this namespace isolation data", "type": "string" }, "type": "array" }, "primary": { "description": "The list of primary brokers for serving the list of namespaces in this isolation policy", "items": { "description": "The list of primary brokers for serving the list of namespaces in this isolation policy", "type": "string" }, "type": "array" }, "secondary": { "description": "The list of secondary brokers for serving the list of namespaces in this isolation policy", "items": { "description": "The list of secondary brokers for serving the list of namespaces in this isolation policy", "type": "string" }, "type": "array" }, "unload_scope": { "description": "The type of unload to perform while applying the new isolation policy.", "enum": [ "all_matching", "none", "changed" ], "example": "'changed' (default) for unloading only the namespaces whose placement is actually changing. 'all_matching' for unloading all matching namespaces. 'none' for not unloading any namespaces.", "type": "string" } }, "type": "object" }, "NamespaceOwnershipStatus": { "properties": { "broker_assignment": { "enum": [ "primary", "secondary", "shared" ], "type": "string" }, "is_active": { "type": "boolean" }, "is_controlled": { "type": "boolean" } }, "type": "object" }, "NonPersistentPartitionedTopicStatsImpl": { "properties": { "abortedTxnCount": { "format": "int64", "type": "integer" }, "averageMsgSize": { "format": "double", "type": "number" }, "backlogQuotaLimitSize": { "format": "int64", "type": "integer" }, "backlogQuotaLimitTime": { "format": "int64", "type": "integer" }, "backlogSize": { "format": "int64", "type": "integer" }, "bytesInCounter": { "format": "int64", "type": "integer" }, "bytesOutCounter": { "format": "int64", "type": "integer" }, "bytesOutInternalCounter": { "format": "int64", "type": "integer" }, "committedTxnCount": { "format": "int64", "type": "integer" }, "compaction": { "$ref": "#/components/schemas/CompactionStatsImpl" }, "deduplicationStatus": { "type": "string" }, "delayedMessageIndexSizeInBytes": { "format": "int64", "type": "integer" }, "earliestMsgPublishTimeInBacklogs": { "format": "int64", "type": "integer" }, "lastOffloadFailureTimeStamp": { "format": "int64", "type": "integer" }, "lastOffloadLedgerId": { "format": "int64", "type": "integer" }, "lastOffloadSuccessTimeStamp": { "format": "int64", "type": "integer" }, "lastPublishTimeStamp": { "format": "int64", "type": "integer" }, "metadata": { "$ref": "#/components/schemas/PartitionedTopicMetadata" }, "msgChunkPublished": { "type": "boolean" }, "msgDropRate": { "format": "double", "type": "number" }, "msgInCounter": { "format": "int64", "type": "integer" }, "msgOutCounter": { "format": "int64", "type": "integer" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "nonContiguousDeletedMessagesRanges": { "format": "int32", "type": "integer" }, "nonContiguousDeletedMessagesRangesSerializedSize": { "format": "int32", "type": "integer" }, "offloadedStorageSize": { "format": "int64", "type": "integer" }, "oldestBacklogMessageAgeSeconds": { "format": "int64", "type": "integer" }, "oldestBacklogMessageSubscriptionName": { "type": "string" }, "ongoingTxnCount": { "format": "int64", "type": "integer" }, "ownerBroker": { "type": "string" }, "partitions": { "additionalProperties": { "$ref": "#/components/schemas/NonPersistentTopicStatsImpl" }, "type": "object" }, "publishRateLimitedTimes": { "format": "int64", "type": "integer" }, "publishers": { "items": { "$ref": "#/components/schemas/NonPersistentPublisherStats" }, "type": "array" }, "replication": { "additionalProperties": { "$ref": "#/components/schemas/NonPersistentReplicatorStats" }, "type": "object" }, "storageSize": { "format": "int64", "type": "integer" }, "subscriptions": { "additionalProperties": { "$ref": "#/components/schemas/NonPersistentSubscriptionStats" }, "type": "object" }, "systemTopicBytesInCounter": { "format": "int64", "type": "integer" }, "topicCreationTimeStamp": { "format": "int64", "type": "integer" }, "topicEpoch": { "format": "int64", "type": "integer" }, "waitingPublishers": { "format": "int32", "type": "integer" } }, "type": "object" }, "NonPersistentPublisherStats": { "properties": { "accessMode": { "enum": [ "Shared", "Exclusive", "ExclusiveWithFencing", "WaitForExclusive" ], "type": "string" }, "address": { "type": "string" }, "averageMsgSize": { "format": "double", "type": "number" }, "chunkedMessageRate": { "format": "double", "type": "number" }, "clientVersion": { "type": "string" }, "connectedSince": { "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "msgDropRate": { "format": "double", "type": "number" }, "msgRateIn": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "producerId": { "format": "int64", "type": "integer" }, "producerName": { "type": "string" }, "supportsPartialProducer": { "type": "boolean" } }, "type": "object" }, "NonPersistentReplicatorStats": { "properties": { "bytesInCount": { "format": "int64", "type": "integer" }, "bytesOutCount": { "format": "int64", "type": "integer" }, "connected": { "type": "boolean" }, "inboundConnectedSince": { "type": "string" }, "inboundConnection": { "type": "string" }, "msgDropCount": { "format": "int64", "type": "integer" }, "msgDropRate": { "format": "double", "type": "number" }, "msgExpiredCount": { "format": "int64", "type": "integer" }, "msgInCount": { "format": "int64", "type": "integer" }, "msgOutCount": { "format": "int64", "type": "integer" }, "msgRateExpired": { "format": "double", "type": "number" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "outboundConnectedSince": { "type": "string" }, "outboundConnection": { "type": "string" }, "replicationBacklog": { "format": "int64", "type": "integer" }, "replicationDelayInSeconds": { "format": "int64", "type": "integer" } }, "type": "object" }, "NonPersistentSubscriptionStats": { "properties": { "activeConsumerName": { "type": "string" }, "allowOutOfOrderDelivery": { "type": "boolean" }, "backlogSize": { "format": "int64", "type": "integer" }, "blockedSubscriptionOnUnackedMsgs": { "type": "boolean" }, "bytesOutCounter": { "format": "int64", "type": "integer" }, "chunkedMessageRate": { "format": "double", "type": "number" }, "consumers": { "items": { "$ref": "#/components/schemas/ConsumerStats" }, "type": "array" }, "consumersAfterMarkDeletePosition": { "additionalProperties": { "type": "string" }, "type": "object" }, "delayedMessageIndexSizeInBytes": { "format": "int64", "type": "integer" }, "dispatchThrottledBytesEventsByBrokerLimit": { "format": "int64", "type": "integer" }, "dispatchThrottledBytesEventsBySubscriptionLimit": { "format": "int64", "type": "integer" }, "dispatchThrottledBytesEventsByTopicLimit": { "format": "int64", "type": "integer" }, "dispatchThrottledMsgEventsByBrokerLimit": { "format": "int64", "type": "integer" }, "dispatchThrottledMsgEventsBySubscriptionLimit": { "format": "int64", "type": "integer" }, "dispatchThrottledMsgEventsByTopicLimit": { "format": "int64", "type": "integer" }, "drainingHashesClearedTotal": { "format": "int64", "type": "integer" }, "drainingHashesCount": { "format": "int32", "type": "integer" }, "drainingHashesUnackedMessages": { "format": "int32", "type": "integer" }, "durable": { "type": "boolean" }, "earliestMsgPublishTimeInBacklog": { "format": "int64", "type": "integer" }, "filterAcceptedMsgCount": { "format": "int64", "type": "integer" }, "filterProcessedMsgCount": { "format": "int64", "type": "integer" }, "filterRejectedMsgCount": { "format": "int64", "type": "integer" }, "filterRescheduledMsgCount": { "format": "int64", "type": "integer" }, "keySharedMode": { "type": "string" }, "lastAckedTimestamp": { "format": "int64", "type": "integer" }, "lastConsumedFlowTimestamp": { "format": "int64", "type": "integer" }, "lastConsumedTimestamp": { "format": "int64", "type": "integer" }, "lastExpireTimestamp": { "format": "int64", "type": "integer" }, "lastMarkDeleteAdvancedTimestamp": { "format": "int64", "type": "integer" }, "messageAckRate": { "format": "double", "type": "number" }, "msgBacklog": { "format": "int64", "type": "integer" }, "msgBacklogNoDelayed": { "format": "int64", "type": "integer" }, "msgDelayed": { "format": "int64", "type": "integer" }, "msgDropRate": { "format": "double", "type": "number" }, "msgInReplay": { "format": "int64", "type": "integer" }, "msgOutCounter": { "format": "int64", "type": "integer" }, "msgRateExpired": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgRateRedeliver": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "nonContiguousDeletedMessagesRanges": { "format": "int32", "type": "integer" }, "nonContiguousDeletedMessagesRangesSerializedSize": { "format": "int32", "type": "integer" }, "replicated": { "type": "boolean" }, "subscriptionProperties": { "additionalProperties": { "type": "string" }, "type": "object" }, "totalMsgExpired": { "format": "int64", "type": "integer" }, "type": { "type": "string" }, "unackedMessages": { "format": "int64", "type": "integer" } }, "type": "object" }, "NonPersistentTopicStatsImpl": { "properties": { "abortedTxnCount": { "format": "int64", "type": "integer" }, "averageMsgSize": { "format": "double", "type": "number" }, "backlogQuotaLimitSize": { "format": "int64", "type": "integer" }, "backlogQuotaLimitTime": { "format": "int64", "type": "integer" }, "backlogSize": { "format": "int64", "type": "integer" }, "bytesInCounter": { "format": "int64", "type": "integer" }, "bytesOutCounter": { "format": "int64", "type": "integer" }, "bytesOutInternalCounter": { "format": "int64", "type": "integer" }, "committedTxnCount": { "format": "int64", "type": "integer" }, "compaction": { "$ref": "#/components/schemas/CompactionStatsImpl" }, "deduplicationStatus": { "type": "string" }, "delayedMessageIndexSizeInBytes": { "format": "int64", "type": "integer" }, "earliestMsgPublishTimeInBacklogs": { "format": "int64", "type": "integer" }, "lastOffloadFailureTimeStamp": { "format": "int64", "type": "integer" }, "lastOffloadLedgerId": { "format": "int64", "type": "integer" }, "lastOffloadSuccessTimeStamp": { "format": "int64", "type": "integer" }, "lastPublishTimeStamp": { "format": "int64", "type": "integer" }, "msgChunkPublished": { "type": "boolean" }, "msgDropRate": { "format": "double", "type": "number" }, "msgInCounter": { "format": "int64", "type": "integer" }, "msgOutCounter": { "format": "int64", "type": "integer" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "nonContiguousDeletedMessagesRanges": { "format": "int32", "type": "integer" }, "nonContiguousDeletedMessagesRangesSerializedSize": { "format": "int32", "type": "integer" }, "offloadedStorageSize": { "format": "int64", "type": "integer" }, "oldestBacklogMessageAgeSeconds": { "format": "int64", "type": "integer" }, "oldestBacklogMessageSubscriptionName": { "type": "string" }, "ongoingTxnCount": { "format": "int64", "type": "integer" }, "ownerBroker": { "type": "string" }, "publishRateLimitedTimes": { "format": "int64", "type": "integer" }, "publishers": { "items": { "$ref": "#/components/schemas/NonPersistentPublisherStats" }, "type": "array" }, "replication": { "additionalProperties": { "$ref": "#/components/schemas/NonPersistentReplicatorStats" }, "type": "object" }, "storageSize": { "format": "int64", "type": "integer" }, "subscriptions": { "additionalProperties": { "$ref": "#/components/schemas/NonPersistentSubscriptionStats" }, "type": "object" }, "systemTopicBytesInCounter": { "format": "int64", "type": "integer" }, "topicCreationTimeStamp": { "format": "int64", "type": "integer" }, "topicEpoch": { "format": "int64", "type": "integer" }, "waitingPublishers": { "format": "int32", "type": "integer" } }, "type": "object" }, "OffloadPolicies": { "properties": { "fileSystemProfilePath": { "type": "string" }, "fileSystemURI": { "type": "string" }, "gcsManagedLedgerOffloadBucket": { "type": "string" }, "gcsManagedLedgerOffloadMaxBlockSizeInBytes": { "format": "int32", "type": "integer" }, "gcsManagedLedgerOffloadReadBufferSizeInBytes": { "format": "int32", "type": "integer" }, "gcsManagedLedgerOffloadRegion": { "type": "string" }, "gcsManagedLedgerOffloadServiceAccountKeyFile": { "type": "string" }, "managedLedgerOffloadBucket": { "type": "string" }, "managedLedgerOffloadDeletionLagInMillis": { "format": "int64", "type": "integer" }, "managedLedgerOffloadDriver": { "type": "string" }, "managedLedgerOffloadMaxBlockSizeInBytes": { "format": "int32", "type": "integer" }, "managedLedgerOffloadMaxThreads": { "format": "int32", "type": "integer" }, "managedLedgerOffloadPrefetchRounds": { "format": "int32", "type": "integer" }, "managedLedgerOffloadReadBufferSizeInBytes": { "format": "int32", "type": "integer" }, "managedLedgerOffloadRegion": { "type": "string" }, "managedLedgerOffloadServiceEndpoint": { "type": "string" }, "managedLedgerOffloadThresholdInBytes": { "format": "int64", "type": "integer" }, "managedLedgerOffloadThresholdInSeconds": { "format": "int64", "type": "integer" }, "managedLedgerOffloadedReadPriority": { "enum": [ "bookkeeper-first", "tiered-storage-first" ], "type": "string" }, "offloadersDirectory": { "type": "string" }, "s3ManagedLedgerOffloadBucket": { "type": "string" }, "s3ManagedLedgerOffloadCredentialId": { "type": "string" }, "s3ManagedLedgerOffloadCredentialSecret": { "type": "string" }, "s3ManagedLedgerOffloadMaxBlockSizeInBytes": { "format": "int32", "type": "integer" }, "s3ManagedLedgerOffloadReadBufferSizeInBytes": { "format": "int32", "type": "integer" }, "s3ManagedLedgerOffloadRegion": { "type": "string" }, "s3ManagedLedgerOffloadRole": { "type": "string" }, "s3ManagedLedgerOffloadRoleSessionName": { "type": "string" }, "s3ManagedLedgerOffloadServiceEndpoint": { "type": "string" } }, "type": "object" }, "OffloadPoliciesImpl": { "properties": { "fileSystemDriver": { "type": "boolean" }, "fileSystemProfilePath": { "type": "string" }, "fileSystemURI": { "type": "string" }, "gcsDriver": { "type": "boolean" }, "gcsManagedLedgerOffloadBucket": { "type": "string" }, "gcsManagedLedgerOffloadMaxBlockSizeInBytes": { "format": "int32", "type": "integer" }, "gcsManagedLedgerOffloadReadBufferSizeInBytes": { "format": "int32", "type": "integer" }, "gcsManagedLedgerOffloadRegion": { "type": "string" }, "gcsManagedLedgerOffloadServiceAccountKeyFile": { "type": "string" }, "managedLedgerExtraConfigurations": { "additionalProperties": { "type": "string" }, "type": "object" }, "managedLedgerOffloadBucket": { "type": "string" }, "managedLedgerOffloadDeletionLagInMillis": { "format": "int64", "type": "integer" }, "managedLedgerOffloadDriver": { "type": "string" }, "managedLedgerOffloadMaxBlockSizeInBytes": { "format": "int32", "type": "integer" }, "managedLedgerOffloadMaxThreads": { "format": "int32", "type": "integer" }, "managedLedgerOffloadPrefetchRounds": { "format": "int32", "type": "integer" }, "managedLedgerOffloadReadBufferSizeInBytes": { "format": "int32", "type": "integer" }, "managedLedgerOffloadReadThreads": { "format": "int32", "type": "integer" }, "managedLedgerOffloadRegion": { "type": "string" }, "managedLedgerOffloadServiceEndpoint": { "type": "string" }, "managedLedgerOffloadThresholdInBytes": { "format": "int64", "type": "integer" }, "managedLedgerOffloadThresholdInSeconds": { "format": "int64", "type": "integer" }, "managedLedgerOffloadedReadPriority": { "enum": [ "bookkeeper-first", "tiered-storage-first" ], "type": "string" }, "offloadersDirectory": { "type": "string" }, "s3Driver": { "type": "boolean" }, "s3ManagedLedgerOffloadBucket": { "type": "string" }, "s3ManagedLedgerOffloadCredentialId": { "type": "string" }, "s3ManagedLedgerOffloadCredentialSecret": { "type": "string" }, "s3ManagedLedgerOffloadMaxBlockSizeInBytes": { "format": "int32", "type": "integer" }, "s3ManagedLedgerOffloadReadBufferSizeInBytes": { "format": "int32", "type": "integer" }, "s3ManagedLedgerOffloadRegion": { "type": "string" }, "s3ManagedLedgerOffloadRole": { "type": "string" }, "s3ManagedLedgerOffloadRoleSessionName": { "type": "string" }, "s3ManagedLedgerOffloadServiceEndpoint": { "type": "string" } }, "type": "object" }, "OffloadProcessStatus": { "properties": { "firstUnoffloadedMessage": { "$ref": "#/components/schemas/MessageId" }, "lastError": { "type": "string" }, "status": { "enum": [ "NOT_RUN", "RUNNING", "SUCCESS", "ERROR" ], "type": "string" } }, "type": "object" }, "PartitionedManagedLedgerInfo": { "properties": { "creationDate": { "type": "string" }, "cursors": { "additionalProperties": { "$ref": "#/components/schemas/CursorInfo" }, "type": "object" }, "ledgers": { "items": { "$ref": "#/components/schemas/LedgerInfo" }, "type": "array" }, "modificationDate": { "type": "string" }, "partitions": { "additionalProperties": { "$ref": "#/components/schemas/ManagedLedgerInfo" }, "type": "object" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "terminatedPosition": { "$ref": "#/components/schemas/PositionInfo" }, "version": { "format": "int64", "type": "integer" } }, "type": "object" }, "PartitionedTopicInternalStats": { "properties": { "metadata": { "$ref": "#/components/schemas/PartitionedTopicMetadata" }, "partitions": { "additionalProperties": { "$ref": "#/components/schemas/PersistentTopicInternalStats" }, "type": "object" } }, "type": "object" }, "PartitionedTopicMetadata": { "properties": { "deleted": { "type": "boolean" }, "partitions": { "format": "int32", "type": "integer" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "PartitionedTopicStatsImpl": { "properties": { "abortedTxnCount": { "format": "int64", "type": "integer" }, "averageMsgSize": { "format": "double", "type": "number" }, "backlogQuotaLimitSize": { "format": "int64", "type": "integer" }, "backlogQuotaLimitTime": { "format": "int64", "type": "integer" }, "backlogSize": { "format": "int64", "type": "integer" }, "bytesInCounter": { "format": "int64", "type": "integer" }, "bytesOutCounter": { "format": "int64", "type": "integer" }, "bytesOutInternalCounter": { "format": "int64", "type": "integer" }, "committedTxnCount": { "format": "int64", "type": "integer" }, "compaction": { "$ref": "#/components/schemas/CompactionStatsImpl" }, "deduplicationStatus": { "type": "string" }, "delayedMessageIndexSizeInBytes": { "format": "int64", "type": "integer" }, "earliestMsgPublishTimeInBacklogs": { "format": "int64", "type": "integer" }, "lastOffloadFailureTimeStamp": { "format": "int64", "type": "integer" }, "lastOffloadLedgerId": { "format": "int64", "type": "integer" }, "lastOffloadSuccessTimeStamp": { "format": "int64", "type": "integer" }, "lastPublishTimeStamp": { "format": "int64", "type": "integer" }, "metadata": { "$ref": "#/components/schemas/PartitionedTopicMetadata" }, "msgChunkPublished": { "type": "boolean" }, "msgInCounter": { "format": "int64", "type": "integer" }, "msgOutCounter": { "format": "int64", "type": "integer" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "nonContiguousDeletedMessagesRanges": { "format": "int32", "type": "integer" }, "nonContiguousDeletedMessagesRangesSerializedSize": { "format": "int32", "type": "integer" }, "offloadedStorageSize": { "format": "int64", "type": "integer" }, "oldestBacklogMessageAgeSeconds": { "format": "int64", "type": "integer" }, "oldestBacklogMessageSubscriptionName": { "type": "string" }, "ongoingTxnCount": { "format": "int64", "type": "integer" }, "ownerBroker": { "type": "string" }, "partitions": { "additionalProperties": { "$ref": "#/components/schemas/TopicStats" }, "type": "object" }, "publishRateLimitedTimes": { "format": "int64", "type": "integer" }, "publishers": { "items": { "$ref": "#/components/schemas/PublisherStats" }, "type": "array" }, "replication": { "additionalProperties": { "$ref": "#/components/schemas/ReplicatorStats" }, "type": "object" }, "storageSize": { "format": "int64", "type": "integer" }, "subscriptions": { "additionalProperties": { "$ref": "#/components/schemas/SubscriptionStats" }, "type": "object" }, "systemTopicBytesInCounter": { "format": "int64", "type": "integer" }, "topicCreationTimeStamp": { "format": "int64", "type": "integer" }, "topicEpoch": { "format": "int64", "type": "integer" }, "waitingPublishers": { "format": "int32", "type": "integer" } }, "type": "object" }, "PendingBookieOpsStats": { "properties": { "cursorLedgerCloseOp": { "format": "int64", "type": "integer" }, "cursorLedgerCreateOp": { "format": "int64", "type": "integer" }, "cursorLedgerDeleteOp": { "format": "int64", "type": "integer" }, "cursorLedgerOpenOp": { "format": "int64", "type": "integer" }, "dataLedgerCloseOp": { "format": "int64", "type": "integer" }, "dataLedgerCreateOp": { "format": "int64", "type": "integer" }, "dataLedgerDeleteOp": { "format": "int64", "type": "integer" }, "dataLedgerOpenOp": { "format": "int64", "type": "integer" } }, "type": "object" }, "PersistencePolicies": { "properties": { "bookkeeperAckQuorum": { "format": "int32", "type": "integer" }, "bookkeeperEnsemble": { "format": "int32", "type": "integer" }, "bookkeeperWriteQuorum": { "format": "int32", "type": "integer" }, "managedLedgerMaxMarkDeleteRate": { "format": "double", "type": "number" }, "managedLedgerStorageClassName": { "type": "string" } }, "type": "object" }, "PersistentOfflineTopicStats": { "properties": { "brokerName": { "type": "string" }, "cursorDetails": { "additionalProperties": { "$ref": "#/components/schemas/CursorDetails" }, "type": "object" }, "dataLedgerDetails": { "items": { "$ref": "#/components/schemas/LedgerDetails" }, "type": "array" }, "messageBacklog": { "format": "int64", "type": "integer" }, "statGeneratedAt": { "format": "date-time", "type": "string" }, "storageSize": { "format": "int64", "type": "integer" }, "topicName": { "type": "string" }, "totalMessages": { "format": "int64", "type": "integer" } }, "type": "object" }, "PersistentTopicInternalStats": { "properties": { "compactedLedger": { "$ref": "#/components/schemas/LedgerInfo" }, "currentLedgerEntries": { "format": "int64", "type": "integer" }, "currentLedgerSize": { "format": "int64", "type": "integer" }, "cursors": { "additionalProperties": { "$ref": "#/components/schemas/CursorStats" }, "type": "object" }, "entriesAddedCounter": { "format": "int64", "type": "integer" }, "lastConfirmedEntry": { "type": "string" }, "lastLedgerCreatedTimestamp": { "type": "string" }, "lastLedgerCreationFailureTimestamp": { "type": "string" }, "ledgers": { "items": { "$ref": "#/components/schemas/LedgerInfo" }, "type": "array" }, "numberOfEntries": { "format": "int64", "type": "integer" }, "pendingAddEntriesCount": { "format": "int32", "type": "integer" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "schemaLedgers": { "items": { "$ref": "#/components/schemas/LedgerInfo" }, "type": "array" }, "state": { "type": "string" }, "totalSize": { "format": "int64", "type": "integer" }, "waitingCursorsCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "PersistentTopicStats": { "properties": { "averageMsgSize": { "format": "double", "type": "number" }, "backlogQuotaLimitSize": { "format": "int64", "type": "integer" }, "backlogQuotaLimitTime": { "format": "int64", "type": "integer" }, "backlogSize": { "format": "int64", "type": "integer" }, "bytesInCounter": { "format": "int64", "type": "integer" }, "bytesOutCounter": { "format": "int64", "type": "integer" }, "compaction": { "$ref": "#/components/schemas/CompactionStats" }, "deduplicationStatus": { "type": "string" }, "delayedMessageIndexSizeInBytes": { "format": "int64", "type": "integer" }, "earliestMsgPublishTimeInBacklogs": { "format": "int64", "type": "integer" }, "lastPublishTimeStamp": { "format": "int64", "type": "integer" }, "msgChunkPublished": { "type": "boolean" }, "msgInCounter": { "format": "int64", "type": "integer" }, "msgOutCounter": { "format": "int64", "type": "integer" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "nonContiguousDeletedMessagesRanges": { "format": "int32", "type": "integer" }, "nonContiguousDeletedMessagesRangesSerializedSize": { "format": "int32", "type": "integer" }, "offloadedStorageSize": { "format": "int64", "type": "integer" }, "oldestBacklogMessageAgeSeconds": { "format": "int64", "type": "integer" }, "oldestBacklogMessageSubscriptionName": { "type": "string" }, "ownerBroker": { "type": "string" }, "publishers": { "items": { "$ref": "#/components/schemas/PublisherStats" }, "type": "array" }, "replication": { "additionalProperties": { "$ref": "#/components/schemas/ReplicatorStats" }, "type": "object" }, "storageSize": { "format": "int64", "type": "integer" }, "subscriptions": { "additionalProperties": { "$ref": "#/components/schemas/SubscriptionStats" }, "type": "object" }, "topicCreationTimeStamp": { "format": "int64", "type": "integer" }, "topicEpoch": { "format": "int64", "type": "integer" }, "waitingPublishers": { "format": "int32", "type": "integer" } }, "type": "object" }, "Policies": { "properties": { "allowed_clusters": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "allowed_topic_property_keys_for_metrics": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "auth_policies": { "$ref": "#/components/schemas/AuthPolicies" }, "autoSubscriptionCreationOverride": { "$ref": "#/components/schemas/AutoSubscriptionCreationOverride" }, "autoTopicCreationOverride": { "$ref": "#/components/schemas/AutoTopicCreationOverride" }, "backlog_quota_map": { "additionalProperties": { "$ref": "#/components/schemas/BacklogQuota" }, "type": "object" }, "bundles": { "$ref": "#/components/schemas/BundlesData" }, "clusterDispatchRate": { "additionalProperties": { "$ref": "#/components/schemas/DispatchRateImpl" }, "type": "object" }, "clusterSubscribeRate": { "additionalProperties": { "$ref": "#/components/schemas/SubscribeRate" }, "type": "object" }, "compaction_threshold": { "format": "int64", "type": "integer" }, "deduplicationEnabled": { "type": "boolean" }, "deduplicationSnapshotIntervalSeconds": { "format": "int32", "type": "integer" }, "delayed_delivery_policies": { "$ref": "#/components/schemas/DelayedDeliveryPolicies" }, "deleted": { "type": "boolean" }, "dispatcherPauseOnAckStatePersistentEnabled": { "type": "boolean" }, "encryption_required": { "type": "boolean" }, "entryFilters": { "$ref": "#/components/schemas/EntryFilters" }, "inactive_topic_policies": { "$ref": "#/components/schemas/InactiveTopicPolicies" }, "is_allow_auto_update_schema": { "type": "boolean" }, "is_allow_auto_update_schema_with_replicator": { "type": "boolean" }, "latency_stats_sample_rate": { "additionalProperties": { "format": "int32", "type": "integer" }, "type": "object" }, "max_consumers_per_subscription": { "format": "int32", "type": "integer" }, "max_consumers_per_topic": { "format": "int32", "type": "integer" }, "max_producers_per_topic": { "format": "int32", "type": "integer" }, "max_subscriptions_per_topic": { "format": "int32", "type": "integer" }, "max_topics_per_namespace": { "format": "int32", "type": "integer" }, "max_unacked_messages_per_consumer": { "format": "int32", "type": "integer" }, "max_unacked_messages_per_subscription": { "format": "int32", "type": "integer" }, "message_ttl_in_seconds": { "format": "int32", "type": "integer" }, "migrated": { "type": "boolean" }, "offload_deletion_lag_ms": { "format": "int64", "type": "integer" }, "offload_policies": { "$ref": "#/components/schemas/OffloadPolicies" }, "offload_threshold": { "format": "int64", "type": "integer" }, "offload_threshold_in_seconds": { "format": "int64", "type": "integer" }, "persistence": { "$ref": "#/components/schemas/PersistencePolicies" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "publishMaxMessageRate": { "additionalProperties": { "$ref": "#/components/schemas/PublishRate" }, "type": "object" }, "replication_clusters": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "replicatorDispatchRate": { "additionalProperties": { "$ref": "#/components/schemas/DispatchRateImpl" }, "type": "object" }, "resource_group_name": { "type": "string" }, "retention_policies": { "$ref": "#/components/schemas/RetentionPolicies" }, "scalableTopicAutoScalePolicy": { "$ref": "#/components/schemas/AutoScalePolicyOverride" }, "schema_auto_update_compatibility_strategy": { "enum": [ "AutoUpdateDisabled", "Backward", "Forward", "Full", "AlwaysCompatible", "BackwardTransitive", "ForwardTransitive", "FullTransitive" ], "type": "string" }, "schema_compatibility_strategy": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" }, "schema_validation_enforced": { "type": "boolean" }, "subscriptionDispatchRate": { "additionalProperties": { "$ref": "#/components/schemas/DispatchRateImpl" }, "type": "object" }, "subscription_auth_mode": { "enum": [ "None", "Prefix" ], "type": "string" }, "subscription_expiration_time_minutes": { "format": "int32", "type": "integer" }, "subscription_types_enabled": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "topicDispatchRate": { "additionalProperties": { "$ref": "#/components/schemas/DispatchRateImpl" }, "type": "object" } }, "type": "object" }, "PoolArenaStats": { "properties": { "chunkLists": { "items": { "$ref": "#/components/schemas/PoolChunkListStats" }, "type": "array" }, "numActiveAllocations": { "format": "int64", "type": "integer" }, "numActiveHugeAllocations": { "format": "int64", "type": "integer" }, "numActiveNormalAllocations": { "format": "int64", "type": "integer" }, "numActiveSmallAllocations": { "format": "int64", "type": "integer" }, "numAllocations": { "format": "int64", "type": "integer" }, "numChunkLists": { "format": "int32", "type": "integer" }, "numDeallocations": { "format": "int64", "type": "integer" }, "numHugeAllocations": { "format": "int64", "type": "integer" }, "numHugeDeallocations": { "format": "int64", "type": "integer" }, "numNormalAllocations": { "format": "int64", "type": "integer" }, "numNormalDeallocations": { "format": "int64", "type": "integer" }, "numSmallAllocations": { "format": "int64", "type": "integer" }, "numSmallDeallocations": { "format": "int64", "type": "integer" }, "numSmallSubpages": { "format": "int32", "type": "integer" }, "smallSubpages": { "items": { "$ref": "#/components/schemas/PoolSubpageStats" }, "type": "array" } }, "type": "object" }, "PoolChunkListStats": { "properties": { "chunks": { "items": { "$ref": "#/components/schemas/PoolChunkStats" }, "type": "array" }, "maxUsage": { "format": "int32", "type": "integer" }, "minUsage": { "format": "int32", "type": "integer" } }, "type": "object" }, "PoolChunkStats": { "properties": { "chunkSize": { "format": "int32", "type": "integer" }, "freeBytes": { "format": "int32", "type": "integer" }, "usage": { "format": "int32", "type": "integer" } }, "type": "object" }, "PoolSubpageStats": { "properties": { "elementSize": { "format": "int32", "type": "integer" }, "maxNumElements": { "format": "int32", "type": "integer" }, "numAvailable": { "format": "int32", "type": "integer" }, "pageSize": { "format": "int32", "type": "integer" } }, "type": "object" }, "PositionInfo": { "properties": { "entryId": { "format": "int64", "type": "integer" }, "ledgerId": { "format": "int64", "type": "integer" } }, "type": "object" }, "PostSchemaPayload": { "properties": { "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "schema": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "PostSchemaResponse": { "properties": { "version": { "$ref": "#/components/schemas/SchemaVersion" } }, "type": "object" }, "PublishRate": { "properties": { "publishThrottlingRateInByte": { "format": "int64", "type": "integer" }, "publishThrottlingRateInMsg": { "format": "int32", "type": "integer" } }, "type": "object" }, "PublisherStats": { "properties": { "accessMode": { "enum": [ "Shared", "Exclusive", "ExclusiveWithFencing", "WaitForExclusive" ], "type": "string" }, "address": { "type": "string" }, "averageMsgSize": { "format": "double", "type": "number" }, "chunkedMessageRate": { "format": "double", "type": "number" }, "clientVersion": { "type": "string" }, "connectedSince": { "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "msgRateIn": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "producerId": { "format": "int64", "type": "integer" }, "producerName": { "type": "string" }, "supportsPartialProducer": { "type": "boolean" } }, "type": "object" }, "RawBookieInfo": { "properties": { "bookieId": { "type": "string" } }, "type": "object" }, "ReplicatorStats": { "properties": { "bytesInCount": { "format": "int64", "type": "integer" }, "bytesOutCount": { "format": "int64", "type": "integer" }, "connected": { "type": "boolean" }, "inboundConnectedSince": { "type": "string" }, "inboundConnection": { "type": "string" }, "msgExpiredCount": { "format": "int64", "type": "integer" }, "msgInCount": { "format": "int64", "type": "integer" }, "msgOutCount": { "format": "int64", "type": "integer" }, "msgRateExpired": { "format": "double", "type": "number" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "outboundConnectedSince": { "type": "string" }, "outboundConnection": { "type": "string" }, "replicationBacklog": { "format": "int64", "type": "integer" }, "replicationDelayInSeconds": { "format": "int64", "type": "integer" } }, "type": "object" }, "ResetCursorData": { "properties": { "batchIndex": { "format": "int32", "type": "integer" }, "entryId": { "format": "int64", "type": "integer" }, "excluded": { "type": "boolean" }, "ledgerId": { "format": "int64", "type": "integer" }, "partitionIndex": { "format": "int32", "type": "integer" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "ResourceDescription": { "properties": { "resourceUsage": { "additionalProperties": { "$ref": "#/components/schemas/ResourceUsage" }, "type": "object" }, "usagePct": { "format": "int32", "type": "integer" } }, "type": "object" }, "ResourceGroup": { "properties": { "dispatchRateInBytes": { "format": "int64", "type": "integer" }, "dispatchRateInMsgs": { "format": "int32", "type": "integer" }, "publishRateInBytes": { "format": "int64", "type": "integer" }, "publishRateInMsgs": { "format": "int32", "type": "integer" } }, "type": "object" }, "ResourceQuota": { "properties": { "bandwidthIn": { "format": "double", "type": "number" }, "bandwidthOut": { "format": "double", "type": "number" }, "dynamic": { "type": "boolean" }, "memory": { "format": "double", "type": "number" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" } }, "type": "object" }, "ResourceUnit": { "properties": { "availableResource": { "$ref": "#/components/schemas/ResourceDescription" }, "resourceId": { "type": "string" } }, "type": "object" }, "ResourceUsage": { "properties": { "limit": { "format": "double", "type": "number" }, "usage": { "format": "double", "type": "number" } }, "type": "object" }, "RetentionPolicies": { "properties": { "retentionSizeInMB": { "format": "int64", "type": "integer" }, "retentionTimeInMinutes": { "format": "int32", "type": "integer" } }, "type": "object" }, "RevokeTopicPermissionOptions": { "properties": { "role": { "type": "string" }, "topic": { "type": "string" } }, "type": "object" }, "ScalableTopicMetadata": { "properties": { "autoScalePolicy": { "$ref": "#/components/schemas/AutoScalePolicyOverride" }, "epoch": { "format": "int64", "type": "integer" }, "nextSegmentId": { "format": "int64", "type": "integer" }, "properties": { "additionalProperties": { "type": "string" }, "type": "object" }, "segments": { "additionalProperties": { "$ref": "#/components/schemas/SegmentInfo" }, "type": "object" } }, "type": "object" }, "ScalableTopicStats": { "properties": { "activeSegments": { "format": "int32", "type": "integer" }, "epoch": { "format": "int64", "type": "integer" }, "sealedSegments": { "format": "int32", "type": "integer" }, "segments": { "additionalProperties": { "$ref": "#/components/schemas/SegmentStats" }, "type": "object" }, "subscriptions": { "additionalProperties": { "$ref": "#/components/schemas/SubscriptionStats" }, "type": "object" }, "totalSegments": { "format": "int32", "type": "integer" } }, "type": "object" }, "SchemaVersion": { "type": "object" }, "SegmentInfo": { "properties": { "active": { "type": "boolean" }, "childIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "createdAtEpoch": { "format": "int64", "type": "integer" }, "createdAtMs": { "format": "int64", "type": "integer" }, "hashRange": { "$ref": "#/components/schemas/HashRange" }, "leaf": { "type": "boolean" }, "legacy": { "type": "boolean" }, "legacyTopicName": { "type": "string" }, "parentIds": { "items": { "format": "int64", "type": "integer" }, "type": "array" }, "root": { "type": "boolean" }, "sealed": { "type": "boolean" }, "sealedAtEpoch": { "format": "int64", "type": "integer" }, "sealedAtMs": { "format": "int64", "type": "integer" }, "segmentId": { "format": "int64", "type": "integer" }, "state": { "enum": [ "ACTIVE", "SEALED" ], "type": "string" } }, "type": "object" }, "SegmentStats": { "properties": { "name": { "type": "string" }, "state": { "type": "string" } }, "type": "object" }, "Span": { "properties": { "allAttributes": { "$ref": "#/components/schemas/Span" }, "recording": { "type": "boolean" }, "spanContext": { "$ref": "#/components/schemas/SpanContext" }, "status": { "$ref": "#/components/schemas/Span" } }, "type": "object" }, "SpanContext": { "properties": { "remote": { "type": "boolean" }, "sampled": { "type": "boolean" }, "spanId": { "type": "string" }, "spanIdBytes": { "format": "byte", "type": "string" }, "traceFlags": { "$ref": "#/components/schemas/TraceFlags" }, "traceId": { "type": "string" }, "traceIdBytes": { "format": "byte", "type": "string" }, "traceState": { "$ref": "#/components/schemas/TraceState" }, "valid": { "type": "boolean" } }, "type": "object" }, "SubscribeRate": { "properties": { "ratePeriodInSecond": { "format": "int32", "type": "integer" }, "subscribeThrottlingRatePerConsumer": { "format": "int32", "type": "integer" } }, "type": "object" }, "SubscriptionStats": { "properties": { "consumerCount": { "format": "int32", "type": "integer" } }, "type": "object" }, "SystemResourceUsage": { "properties": { "bandwidthIn": { "$ref": "#/components/schemas/ResourceUsage" }, "bandwidthOut": { "$ref": "#/components/schemas/ResourceUsage" }, "cpu": { "$ref": "#/components/schemas/ResourceUsage" }, "directMemory": { "$ref": "#/components/schemas/ResourceUsage" }, "memory": { "$ref": "#/components/schemas/ResourceUsage" } }, "type": "object" }, "TenantInfo": { "description": "Information of adminRoles and allowedClusters for tenant", "properties": { "adminRoles": { "description": "Comma separated list of auth principals allowed to administrate the tenant.", "items": { "description": "Comma separated list of auth principals allowed to administrate the tenant.", "type": "string" }, "type": "array", "uniqueItems": true }, "allowedClusters": { "description": "Comma separated allowed clusters.", "items": { "description": "Comma separated allowed clusters.", "type": "string" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "TopicHashPositions": { "properties": { "bundle": { "type": "string" }, "namespace": { "type": "string" }, "topicHashPositions": { "additionalProperties": { "format": "int64", "type": "integer" }, "type": "object" } }, "type": "object" }, "TopicStats": { "properties": { "averageMsgSize": { "format": "double", "type": "number" }, "backlogQuotaLimitSize": { "format": "int64", "type": "integer" }, "backlogQuotaLimitTime": { "format": "int64", "type": "integer" }, "backlogSize": { "format": "int64", "type": "integer" }, "bytesInCounter": { "format": "int64", "type": "integer" }, "bytesOutCounter": { "format": "int64", "type": "integer" }, "compaction": { "$ref": "#/components/schemas/CompactionStats" }, "deduplicationStatus": { "type": "string" }, "delayedMessageIndexSizeInBytes": { "format": "int64", "type": "integer" }, "earliestMsgPublishTimeInBacklogs": { "format": "int64", "type": "integer" }, "lastPublishTimeStamp": { "format": "int64", "type": "integer" }, "msgChunkPublished": { "type": "boolean" }, "msgInCounter": { "format": "int64", "type": "integer" }, "msgOutCounter": { "format": "int64", "type": "integer" }, "msgRateIn": { "format": "double", "type": "number" }, "msgRateOut": { "format": "double", "type": "number" }, "msgThroughputIn": { "format": "double", "type": "number" }, "msgThroughputOut": { "format": "double", "type": "number" }, "nonContiguousDeletedMessagesRanges": { "format": "int32", "type": "integer" }, "nonContiguousDeletedMessagesRangesSerializedSize": { "format": "int32", "type": "integer" }, "offloadedStorageSize": { "format": "int64", "type": "integer" }, "oldestBacklogMessageAgeSeconds": { "format": "int64", "type": "integer" }, "oldestBacklogMessageSubscriptionName": { "type": "string" }, "ownerBroker": { "type": "string" }, "publishers": { "items": { "$ref": "#/components/schemas/PublisherStats" }, "type": "array" }, "replication": { "additionalProperties": { "$ref": "#/components/schemas/ReplicatorStats" }, "type": "object" }, "storageSize": { "format": "int64", "type": "integer" }, "subscriptions": { "additionalProperties": { "$ref": "#/components/schemas/SubscriptionStats" }, "type": "object" }, "topicCreationTimeStamp": { "format": "int64", "type": "integer" }, "topicEpoch": { "format": "int64", "type": "integer" }, "waitingPublishers": { "format": "int32", "type": "integer" } }, "type": "object" }, "TraceFlags": { "properties": { "sampled": { "type": "boolean" }, "traceIdRandom": { "type": "boolean" } }, "type": "object" }, "TraceState": { "properties": { "empty": { "type": "boolean" } }, "type": "object" }, "WorkerFunctionInstanceStats": { "properties": { "metrics": { "$ref": "#/components/schemas/FunctionInstanceStatsData" }, "name": { "type": "string" } }, "type": "object" }, "WorkerInfo": { "properties": { "port": { "format": "int32", "type": "integer" }, "workerHostname": { "type": "string" }, "workerId": { "type": "string" } }, "type": "object" } } }, "info": { "description": "This provides the REST API for admin operations", "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Pulsar Admin REST API", "version": "v2" }, "openapi": "3.0.1", "paths": { "/admin/v2/bookies/all": { "get": { "operationId": "getAllBookies", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookiesClusterInfo" } } }, "description": "Gets raw information for all the bookies in the cluster" }, "403": { "description": "Don't have admin permission" } }, "summary": "Gets raw information for all the bookies in the cluster", "tags": [ "bookies" ] } }, "/admin/v2/bookies/racks-info": { "get": { "operationId": "getBookiesRackInfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookiesRackConfiguration" } } }, "description": "Gets the rack placement information for all the bookies in the cluster" }, "403": { "description": "Don't have admin permission" } }, "summary": "Gets the rack placement information for all the bookies in the cluster", "tags": [ "bookies" ] } }, "/admin/v2/bookies/racks-info/{bookie}": { "delete": { "operationId": "deleteBookieRackInfo", "parameters": [ { "in": "path", "name": "bookie", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Removed the rack placement information for a specific bookie in the cluster", "tags": [ "bookies" ] }, "get": { "operationId": "getBookieRackInfo", "parameters": [ { "in": "path", "name": "bookie", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookieInfo" } } }, "description": "Gets the rack placement information for a specific bookie in the cluster" }, "403": { "description": "Don't have admin permission" } }, "summary": "Gets the rack placement information for a specific bookie in the cluster", "tags": [ "bookies" ] }, "post": { "operationId": "updateBookieRackInfo", "parameters": [ { "description": "The bookie address", "in": "path", "name": "bookie", "required": true, "schema": { "type": "string" } }, { "description": "The group", "in": "query", "name": "group", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BookieInfo" } } }, "description": "The bookie info", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Updates the rack placement information for a specific bookie in the cluster (note. bookie address format:`address:port`)", "tags": [ "bookies" ] } }, "/admin/v2/broker-stats/allocator-stats/{allocator}": { "get": { "operationId": "getAllocatorStats", "parameters": [ { "in": "path", "name": "allocator", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocatorStats" } } }, "description": "Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'" }, "403": { "description": "Don't have admin permission" } }, "summary": "Get the stats for the Netty allocator. Available allocators are 'default' and 'ml-cache'", "tags": [ "broker-stats" ] } }, "/admin/v2/broker-stats/bookieops": { "get": { "description": "Returns a nested map structure: Map>.", "operationId": "getPendingBookieOpsStats", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "additionalProperties": { "$ref": "#/components/schemas/PendingBookieOpsStats" } }, "type": "object" } } }, "description": "Get pending bookie client op stats by namespace" }, "403": { "description": "Don't have admin permission" } }, "summary": "Get pending bookie client op stats by namespace", "tags": [ "broker-stats" ] } }, "/admin/v2/broker-stats/broker-resource-availability/{tenant}/{namespace}": { "get": { "description": "This API gives the current broker availability in percent, each resource percentage usage is calculated and then sum of all of the resource usage percent is called broker-resource-availability

THIS API IS ONLY FOR USE BY TESTING FOR CONFIRMING NAMESPACE ALLOCATION ALGORITHM", "operationId": "getBrokerResourceAvailability", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/ResourceUnit" }, "type": "object" } } }, "description": "Returns broker resource availability as Map>.Since `ResourceUnit` is an interface, its specific content is not determinable via class reflection. Refer to the source code or interface tests for detailed type definitions." }, "403": { "description": "Don't have admin permission" }, "409": { "description": "Load-manager doesn't support operation" } }, "summary": "Broker availability report", "tags": [ "broker-stats" ] } }, "/admin/v2/broker-stats/load-report": { "get": { "description": "consists of topics stats & systemResourceUsage", "operationId": "getLoadReport", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadReport" } } }, "description": "Get Load for this broker" }, "403": { "description": "Don't have admin permission" } }, "summary": "Get Load for this broker", "tags": [ "broker-stats" ] } }, "/admin/v2/broker-stats/mbeans": { "get": { "operationId": "getMBeans", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Metrics" }, "type": "array" } } }, "description": "Get all the mbean details of this broker JVM" }, "403": { "description": "Don't have admin permission" } }, "summary": "Get all the mbean details of this broker JVM", "tags": [ "broker-stats" ] } }, "/admin/v2/broker-stats/metrics": { "get": { "description": "The request should be executed by the Monitoring agent on each broker to fetch the metrics", "operationId": "getMetrics", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Metrics" }, "type": "array" } } }, "description": "Gets the metrics for Monitoring" }, "403": { "description": "Don't have admin permission" } }, "summary": "Gets the metrics for Monitoring", "tags": [ "broker-stats" ] } }, "/admin/v2/broker-stats/topics": { "get": { "operationId": "getTopics2", "responses": { "200": { "content": { "application/json": { "schema": { "description": "Nested JSON object: namespace -> bundle range -> persistent/non-persistent -> topic -> stats", "type": "object" } } }, "description": "Get all the topic stats by namespace" }, "403": { "description": "Don't have admin permission" } }, "summary": "Get all the topic stats by namespace", "tags": [ "broker-stats" ] } }, "/admin/v2/brokers": { "get": { "operationId": "getActiveBrokers", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the list of active brokers (broker ids) in the local cluster. If authorization is not enabled" }, "401": { "description": "Authentication required" }, "403": { "description": "This operation requires super-user access" } }, "summary": "Get the list of active brokers (broker ids) in the local cluster. If authorization is not enabled", "tags": [ "brokers" ] } }, "/admin/v2/brokers/backlog-quota-check": { "get": { "operationId": "backlogQuotaCheck", "responses": { "204": { "description": "Everything is OK" }, "403": { "description": "Don't have admin permission" }, "500": { "description": "Internal server error" } }, "summary": "A REST endpoint to trigger backlogQuotaCheck", "tags": [ "brokers" ] } }, "/admin/v2/brokers/configuration": { "get": { "operationId": "getDynamicConfigurationName", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get all updatable dynamic configurations' names" }, "403": { "description": "You don't have admin permission to get configuration" } }, "summary": "Get all updatable dynamic configurations' names", "tags": [ "brokers" ] } }, "/admin/v2/brokers/configuration/runtime": { "get": { "operationId": "getRuntimeConfiguration", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Get all runtime configurations. This operation requires Pulsar super-user privileges." }, "403": { "description": "Don't have admin permission" } }, "summary": "Get all runtime configurations. This operation requires Pulsar super-user privileges.", "tags": [ "brokers" ] } }, "/admin/v2/brokers/configuration/values": { "get": { "operationId": "getAllDynamicConfigurations", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Get the values of all dynamic configurations overridden on local config" }, "403": { "description": "You don't have admin permission to view configuration" }, "404": { "description": "Configuration not found" }, "500": { "description": "Internal server error" } }, "summary": "Get the values of all dynamic configurations overridden on local config", "tags": [ "brokers" ] } }, "/admin/v2/brokers/configuration/{configName}": { "delete": { "operationId": "deleteDynamicConfiguration", "parameters": [ { "in": "path", "name": "configName", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Service configuration deleted successfully" }, "403": { "description": "You don't have admin permission to update service-configuration" }, "412": { "description": "Invalid dynamic-config value" }, "500": { "description": "Internal server error" } }, "summary": "Delete dynamic ServiceConfiguration from metadata only. This operation requires Pulsar super-user privileges.", "tags": [ "brokers" ] } }, "/admin/v2/brokers/configuration/{configName}/{configValue}": { "post": { "operationId": "updateDynamicConfiguration", "parameters": [ { "in": "path", "name": "configName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "configValue", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Service configuration updated successfully" }, "403": { "description": "You don't have admin permission to update service-configuration" }, "404": { "description": "Configuration not found" }, "412": { "description": "Invalid dynamic-config value" }, "500": { "description": "Internal server error" } }, "summary": "Update dynamic ServiceConfiguration into zk only. This operation requires Pulsar super-user privileges.", "tags": [ "brokers" ] } }, "/admin/v2/brokers/health": { "get": { "operationId": "healthCheck", "parameters": [ { "in": "query", "name": "brokerId", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Everything is OK" }, "307": { "description": "Current broker is not the target broker" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Cluster doesn't exist" }, "500": { "description": "Internal server error" }, "503": { "description": "Service unavailable" } }, "summary": "Run a healthCheck against the broker", "tags": [ "brokers" ] } }, "/admin/v2/brokers/internal-configuration": { "get": { "operationId": "getInternalConfigurationData", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalConfigurationData" } } }, "description": "Get the internal configuration data" }, "403": { "description": "Don't have admin permission" } }, "summary": "Get the internal configuration data", "tags": [ "brokers" ] } }, "/admin/v2/brokers/leaderBroker": { "get": { "operationId": "getLeaderBroker", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerInfo" } } }, "description": "Get the information of the leader broker." }, "401": { "description": "Authentication required" }, "403": { "description": "This operation requires super-user access" }, "404": { "description": "Leader broker not found" } }, "summary": "Get the information of the leader broker.", "tags": [ "brokers" ] } }, "/admin/v2/brokers/ready": { "get": { "operationId": "isReady", "responses": { "200": { "description": "Broker is ready" }, "500": { "description": "Broker is not ready" } }, "summary": "Check if the broker is fully initialized", "tags": [ "brokers" ] } }, "/admin/v2/brokers/shutdown": { "post": { "operationId": "shutDownBrokerGracefully", "parameters": [ { "description": "If the value is absent (value=0), it means there is no concurrency limit.", "in": "query", "name": "maxConcurrentUnloadPerSec", "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "forcedTerminateTopic", "schema": { "default": true, "type": "boolean" } } ], "responses": { "204": { "description": "Execute shutdown command successfully" }, "403": { "description": "You don't have admin permission to update service-configuration" }, "500": { "description": "Internal server error" } }, "summary": "Shutdown broker gracefully.", "tags": [ "brokers" ] } }, "/admin/v2/brokers/version": { "get": { "operationId": "version", "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "The Pulsar version" }, "500": { "description": "Internal server error" } }, "summary": "Get version of current broker", "tags": [ "brokers" ] } }, "/admin/v2/brokers/{clusterName}/{brokerId}/ownedNamespaces": { "get": { "operationId": "getOwnedNamespaces", "parameters": [ { "in": "path", "name": "clusterName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "brokerId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/NamespaceOwnershipStatus" }, "type": "object" } } }, "description": "Get the list of namespaces served by the specific broker id" }, "307": { "description": "Current broker doesn't serve the cluster" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Cluster doesn't exist" } }, "summary": "Get the list of namespaces served by the specific broker id", "tags": [ "brokers" ] } }, "/admin/v2/brokers/{cluster}": { "get": { "operationId": "getActiveBrokers_1", "parameters": [ { "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the list of active brokers (broker ids) in the cluster. If authorization is not enabled, any cluster name is valid." }, "307": { "description": "Current broker doesn't serve this cluster" }, "401": { "description": "Authentication required" }, "403": { "description": "This operation requires super-user access" }, "404": { "description": "Cluster does not exist: cluster={clustername}" } }, "summary": "Get the list of active brokers (broker ids) in the cluster. If authorization is not enabled, any cluster name is valid.", "tags": [ "brokers" ] } }, "/admin/v2/clusters": { "get": { "operationId": "getClusters", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Return a list of clusters." }, "500": { "description": "Internal server error." } }, "summary": "Get the list of all the Pulsar clusters.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}": { "delete": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "deleteCluster", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Cluster has been deleted." }, "403": { "description": "Don't have admin permission or policies are read-only." }, "404": { "description": "Cluster doesn't exist." }, "412": { "description": "Cluster is not empty." }, "500": { "description": "Internal server error." } }, "summary": "Delete an existing cluster.", "tags": [ "clusters" ] }, "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getCluster", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterData" } } }, "description": "Return the cluster data." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Get the configuration for the specified cluster.", "tags": [ "clusters" ] }, "post": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "updateCluster", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "brokerServiceUrl": "pulsar://pulsar.example.com:6651", "serviceUrl": "http://pulsar.example.com:8080" }, "schema": { "$ref": "#/components/schemas/ClusterData" } } }, "description": "The cluster data", "required": true }, "responses": { "200": { "description": "Cluster has been updated." }, "400": { "description": "Bad request parameter." }, "403": { "description": "Don't have admin permission or policies are read-only." }, "404": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Update the configuration for a cluster.", "tags": [ "clusters" ] }, "put": { "description": "This operation requires Pulsar superuser privileges, and the name cannot contain the '/' characters.", "operationId": "createCluster", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "brokerServiceUrl": "pulsar://pulsar.example.com:6651", "serviceUrl": "http://pulsar.example.com:8080" }, "schema": { "$ref": "#/components/schemas/ClusterData" } } }, "description": "The cluster data", "required": true }, "responses": { "200": { "description": "Cluster has been created." }, "400": { "description": "Bad request parameter." }, "403": { "description": "You don't have admin permission to create the cluster." }, "409": { "description": "Cluster already exists." }, "412": { "description": "Cluster name is not valid." }, "500": { "description": "Internal server error." } }, "summary": "Create a new cluster.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/failureDomains": { "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getFailureDomains", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/FailureDomain" }, "type": "object" } } }, "description": "Get the cluster failure domains." }, "403": { "description": "Don't have admin permission" }, "500": { "description": "Internal server error" } }, "summary": "Get the cluster failure domains.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/failureDomains/{domainName}": { "delete": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "deleteFailureDomain", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "The failure domain name", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Delete the failure domain of the cluster successfully" }, "403": { "description": "Don't have admin permission or policy is read only" }, "404": { "description": "FailureDomain doesn't exist" }, "412": { "description": "Cluster doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Delete the failure domain of the cluster", "tags": [ "clusters" ] }, "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getDomain", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "The failure domain name", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FailureDomain" } } }, "description": "Get a domain in a cluster" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "FailureDomain doesn't exist" }, "412": { "description": "Cluster doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get a domain in a cluster", "tags": [ "clusters" ] }, "post": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "setFailureDomain", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "The failure domain name", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FailureDomain" } } }, "description": "The configuration data of a failure domain", "required": true }, "responses": { "204": { "description": "Set the failure domain of the cluster successfully." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Failure domain doesn't exist." }, "409": { "description": "Broker already exists in another domain." }, "412": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Set the failure domain of the cluster.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/migrate": { "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getClusterMigration", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusterData" } } }, "description": "Return the cluster data." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Get the cluster migration configuration for the specified cluster.", "tags": [ "clusters" ] }, "post": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "updateClusterMigration", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "Is cluster migrated", "in": "query", "name": "migrated", "required": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "example": { "brokerServiceUrl": "pulsar://pulsar.example.com:6651", "serviceUrl": "http://pulsar.example.com:8080" }, "schema": { "$ref": "#/components/schemas/ClusterUrl" } } }, "description": "The cluster url data", "required": true }, "responses": { "200": { "description": "Cluster has been updated." }, "400": { "description": "Cluster url must not be empty." }, "403": { "description": "Don't have admin permission or policies are read-only." }, "404": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Update the configuration for a cluster migration.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/namespaceIsolationPolicies": { "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getNamespaceIsolationPolicies", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/NamespaceIsolationData" }, "type": "object" } } }, "description": "Get the namespace isolation policies assigned to the cluster." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Get the namespace isolation policies assigned to the cluster.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/namespaceIsolationPolicies/brokers": { "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getBrokersWithNamespaceIsolationPolicy", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BrokerNamespaceIsolationData" }, "type": "array", "uniqueItems": true } } }, "description": "Get list of brokers with namespace-isolation policies attached to them." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Namespace-isolation policies not found." }, "412": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Get list of brokers with namespace-isolation policies attached to them.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/namespaceIsolationPolicies/brokers/{broker}": { "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getBrokerWithNamespaceIsolationPolicy", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "The broker name (:)", "example": "broker1:8080", "in": "path", "name": "broker", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerNamespaceIsolationData" } } }, "description": "Get a broker with namespace-isolation policies attached to it." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Namespace-isolation policies/ Broker not found." }, "412": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Get a broker with namespace-isolation policies attached to it.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/namespaceIsolationPolicies/{policyName}": { "delete": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "deleteNamespaceIsolationPolicy", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "The namespace isolation policy name", "in": "path", "name": "policyName", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Delete namespace isolation policy successfully." }, "403": { "description": "Don't have admin permission or policies are read only." }, "404": { "description": "Namespace isolation policy doesn't exist." }, "412": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Delete namespace isolation policy.", "tags": [ "clusters" ] }, "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getNamespaceIsolationPolicy", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "The name of the namespace isolation policy", "in": "path", "name": "policyName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NamespaceIsolationData" } } }, "description": "Get the single namespace isolation policy assigned to the cluster." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Policy doesn't exist." }, "412": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Get the single namespace isolation policy assigned to the cluster.", "tags": [ "clusters" ] }, "post": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "setNamespaceIsolationPolicy", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "description": "The namespace isolation policy name", "in": "path", "name": "policyName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/NamespaceIsolationData" } } }, "description": "The namespace isolation policy data", "required": true }, "responses": { "204": { "description": "Set namespace isolation policy successfully." }, "400": { "description": "Namespace isolation policy data is invalid." }, "403": { "description": "Don't have admin permission or policies are read-only." }, "404": { "description": "Namespace isolation policy doesn't exist." }, "412": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Set namespace isolation policy.", "tags": [ "clusters" ] } }, "/admin/v2/clusters/{cluster}/peers": { "get": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "getPeerCluster", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the peer-cluster data for the specified cluster." }, "403": { "description": "Don't have admin permission." }, "404": { "description": "Cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Get the peer-cluster data for the specified cluster.", "tags": [ "clusters" ] }, "post": { "description": "This operation requires Pulsar superuser privileges.", "operationId": "setPeerClusterNames", "parameters": [ { "description": "The cluster name", "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": [ "cluster-a", "cluster-b" ], "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "The list of peer cluster names", "required": true }, "responses": { "204": { "description": "Cluster has been updated." }, "403": { "description": "Don't have admin permission or policies are read-only." }, "404": { "description": "Cluster doesn't exist." }, "412": { "description": "Peer cluster doesn't exist." }, "500": { "description": "Internal server error." } }, "summary": "Update peer-cluster-list for a cluster.", "tags": [ "clusters" ] } }, "/admin/v2/metadata/migration/start": { "post": { "operationId": "startMigration", "parameters": [ { "description": "Target metadata store URL", "in": "query", "name": "target", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Migration started successfully" }, "400": { "description": "Invalid target URL" }, "409": { "description": "Migration already in progress" }, "500": { "description": "Internal server error" } }, "summary": "Start metadata store migration", "tags": [ "metadata-migration" ] } }, "/admin/v2/metadata/migration/status": { "get": { "operationId": "getStatus", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrationState" } } }, "description": "Migration status retrieved successfully" }, "500": { "description": "Internal server error" } }, "summary": "Get current migration status", "tags": [ "metadata-migration" ] } }, "/admin/v2/namespaces/grantPermissionsOnTopics": { "post": { "operationId": "grantPermissionsOnTopics", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GrantTopicPermissionOptions" }, "type": "array" } } } }, "responses": { "204": { "description": "Operation successful" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Grant new permissions to a role on multi-topics.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/revokePermissionsOnTopics": { "post": { "operationId": "revokePermissionsOnTopics", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/RevokeTopicPermissionOptions" }, "type": "array" } } } }, "responses": { "204": { "description": "Operation successful" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Revoke new permissions to a role on multi-topics.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{cluster}/antiAffinity/{group}": { "get": { "operationId": "getAntiAffinityNamespaces", "parameters": [ { "in": "path", "name": "cluster", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "group", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "tenant", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get all namespaces that are grouped by the given anti-affinity group in a given cluster. This API can only be accessed by an admin of any of the existing tenants." }, "403": { "description": "Don't have admin permission" }, "412": { "description": "Cluster not exist/Anti-affinity group can't be empty." } }, "summary": "Get all namespaces that are grouped by the given anti-affinity group in a given cluster. This API can only be accessed by an admin of any of the existing tenants.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}": { "get": { "operationId": "getTenantNamespaces", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the list of all the namespaces for a certain tenant." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant doesn't exist" } }, "summary": "Get the list of all the namespaces for a certain tenant.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}": { "delete": { "operationId": "deleteNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "405": { "description": "Broker doesn't allow forced deletion of namespaces" }, "409": { "description": "Namespace is not empty" } }, "summary": "Delete a namespace and all the topics under it.", "tags": [ "namespaces" ] }, "get": { "operationId": "getPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Policies" } } }, "description": "Get the dump all the policies specified for a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get the dump all the policies specified for a namespace.", "tags": [ "namespaces" ] }, "put": { "operationId": "createNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Policies" } } }, "description": "Policies for the namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster doesn't exist" }, "409": { "description": "Namespace already exists" }, "412": { "description": "Namespace name is not valid" } }, "summary": "Creates a new namespace with the specified policies", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/allowedClusters": { "get": { "operationId": "getNamespaceAllowedClusters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the allowed clusters for a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Namespace is not global" } }, "summary": "Get the allowed clusters for a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setNamespaceAllowedClusters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "List of allowed clusters", "required": true }, "responses": { "400": { "description": "The list of allowed clusters should include all replication clusters." }, "403": { "description": "The requester does not have admin permissions." }, "404": { "description": "The specified tenant, cluster, or namespace does not exist." }, "409": { "description": "A peer-cluster cannot be part of an allowed-cluster." }, "412": { "description": "The namespace is not global or the provided cluster IDs are invalid." } }, "summary": "Set the allowed clusters for a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/allowedTopicPropertyKeysForMetrics": { "delete": { "operationId": "removeAllowedTopicPropertyKeysForMetrics", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove allowed topic property keys for metrics on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getAllowedTopicPropertyKeysForMetrics", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get allowed topic property keys for metrics for a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Get allowed topic property keys for metrics for a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setAllowedTopicPropertyKeysForMetrics", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Set of allowed topic property keys for metrics", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Set allowed topic property keys for metrics for a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/antiAffinity": { "delete": { "operationId": "removeNamespaceAntiAffinityGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove anti-affinity group of a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getNamespaceAntiAffinityGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Get anti-affinity group of a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get anti-affinity group of a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setNamespaceAntiAffinityGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Anti-affinity group for the specified namespace", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Invalid antiAffinityGroup" } }, "summary": "Set anti-affinity group for a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/autoSubscriptionCreation": { "delete": { "operationId": "removeAutoSubscriptionCreation", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Remove override of broker's allowAutoSubscriptionCreation in a namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getAutoSubscriptionCreation", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoSubscriptionCreationOverrideImpl" } } }, "description": "Get autoSubscriptionCreation info in a namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Get autoSubscriptionCreation info in a namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "setAutoSubscriptionCreation", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoSubscriptionCreationOverride" } } }, "description": "Settings for automatic subscription creation" }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid autoSubscriptionCreation override" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Override broker's allowAutoSubscriptionCreation setting for a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/autoTopicCreation": { "delete": { "operationId": "removeAutoTopicCreation", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Remove override of broker's allowAutoTopicCreation in a namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getAutoTopicCreation", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoTopicCreationOverrideImpl" } } }, "description": "Get autoTopicCreation info in a namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Get autoTopicCreation info in a namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "setAutoTopicCreation", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoTopicCreationOverride" } } }, "description": "Settings for automatic topic creation", "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid autoTopicCreation override" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "406": { "description": "The number of partitions should be less than or equal to maxNumPartitionsPerPartitionedTopic" } }, "summary": "Override broker's allowAutoTopicCreation setting for a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/backlogQuota": { "delete": { "operationId": "removeBacklogQuota", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "backlogQuotaType", "schema": { "enum": [ "destination_storage", "message_age" ], "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove a backlog quota policy from a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setBacklogQuota", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "backlogQuotaType", "schema": { "enum": [ "destination_storage", "message_age" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklogQuota" } } }, "description": "Backlog quota for all topics of the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" } }, "summary": "Set a backlog quota for all the topics on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/backlogQuotaMap": { "get": { "operationId": "getBacklogQuotaMap", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/BacklogQuotaImpl" }, "type": "object" } } }, "description": "Get backlog quota map on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get backlog quota map on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/bundles": { "get": { "operationId": "getBundlesData", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BundlesDataImpl" } } }, "description": "Get the bundles split data." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Namespace is not setup to split in bundles" } }, "summary": "Get the bundles split data.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/clearBacklog": { "post": { "operationId": "clearNamespaceBacklog", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "Namespace does not exist" } }, "summary": "Clear backlog for all topics on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/clearBacklog/{subscription}": { "post": { "operationId": "clearNamespaceBacklogForSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "Namespace does not exist" } }, "summary": "Clear backlog for a given subscription on all topics on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/compactionThreshold": { "delete": { "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disables automatic compaction", "operationId": "deleteCompactionThreshold", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Delete maximum number of uncompacted bytes in a topic before compaction is triggered.", "tags": [ "namespaces" ] }, "get": { "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disables automatic compaction", "operationId": "getCompactionThreshold", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Maximum number of uncompacted bytes in topics before compaction is triggered." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" } }, "summary": "Maximum number of uncompacted bytes in topics before compaction is triggered.", "tags": [ "namespaces" ] }, "put": { "description": "The backlog size is compared to the threshold periodically. A threshold of 0 disables automatic compaction", "operationId": "setCompactionThreshold", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Maximum number of uncompacted bytes in a topic of the specified namespace", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "compactionThreshold value is not valid" } }, "summary": "Set maximum number of uncompacted bytes in a topic before compaction is triggered.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/deduplication": { "delete": { "operationId": "removeDeduplication", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Remove broker side deduplication for all topics in a namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getDeduplication", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get broker side deduplication for all topics in a namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get broker side deduplication for all topics in a namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "modifyDeduplication", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Flag for disabling or enabling broker side deduplication for all topics in the specified namespace", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Enable or disable broker side deduplication for all topics in a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/deduplicationSnapshotInterval": { "get": { "operationId": "getDeduplicationSnapshotInterval", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get deduplicationSnapshotInterval config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get deduplicationSnapshotInterval config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setDeduplicationSnapshotInterval", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Interval to take deduplication snapshot per topic", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Set deduplicationSnapshotInterval config on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/delayedDelivery": { "delete": { "operationId": "removeDelayedDeliveryPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Delete delayed delivery messages config on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getDelayedDeliveryPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelayedDeliveryPolicies" } } }, "description": "Get delayed delivery messages config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Get delayed delivery messages config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setDelayedDeliveryPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelayedDeliveryPolicies" } } }, "description": "Delayed delivery policies for the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Set delayed delivery messages config on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/dispatchRate": { "delete": { "operationId": "deleteDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Delete dispatch-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get dispatch-rate configured for the namespace, null means dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get dispatch-rate configured for the namespace, null means dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", "tags": [ "namespaces" ] }, "post": { "operationId": "setDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Dispatch rate for all topics of the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Set dispatch-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/dispatcherPauseOnAckStatePersistent": { "delete": { "operationId": "removeDispatcherPauseOnAckStatePersistent", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove dispatcher pause on ack state persistent configuration for specified namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getDispatcherPauseOnAckStatePersistent", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get dispatcher pause on ack state persistent config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get dispatcher pause on ack state persistent config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setDispatcherPauseOnAckStatePersistent", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Set dispatcher pause on ack state persistent configuration for specified namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/encryptionRequired": { "get": { "operationId": "getEncryptionRequired", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get message encryption required status in a namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Get message encryption required status in a namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "modifyEncryptionRequired", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Flag defining if message encryption is required", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Message encryption is required or not for all topics in a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/entryFilters": { "delete": { "operationId": "removeNamespaceEntryFilters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Invalid TTL" } }, "summary": "Remove entry filters for namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getEntryFiltersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryFilters" } } }, "description": "Get maxConsumersPerSubscription config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get maxConsumersPerSubscription config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setEntryFiltersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryFilters" } } }, "description": "entry filters", "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Specified entry filters are not valid" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Set entry filters for namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/inactiveTopicPolicies": { "delete": { "operationId": "removeInactiveTopicPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove inactive topic policies from a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getInactiveTopicPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InactiveTopicPolicies" } } }, "description": "Get inactive topic policies config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Get inactive topic policies config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setInactiveTopicPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InactiveTopicPolicies" } } }, "description": "Inactive topic policies for the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Set inactive topic policies config on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/isAllowAutoUpdateSchema": { "get": { "operationId": "getIsAllowAutoUpdateSchema", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "The flag of whether to allow auto update schema" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "The flag of whether to allow auto update schema", "tags": [ "namespaces" ] }, "post": { "operationId": "setIsAllowAutoUpdateSchema", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Allow replicator to auto update schema", "in": "query", "name": "allowAutoUpdateSchemaWithReplicator", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Flag of whether to allow auto update schema", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Update flag of whether to allow auto update schema", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/maxConsumersPerSubscription": { "delete": { "operationId": "removeMaxConsumersPerSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "maxConsumersPerSubscription value is not valid" } }, "summary": "Set maxConsumersPerSubscription configuration on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getMaxConsumersPerSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxConsumersPerSubscription config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get maxConsumersPerSubscription config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setMaxConsumersPerSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Number of maximum consumers per subscription", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "maxConsumersPerSubscription value is not valid" } }, "summary": "Set maxConsumersPerSubscription configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/maxConsumersPerTopic": { "delete": { "operationId": "removeMaxConsumersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxConsumersPerTopic configuration on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getMaxConsumersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxConsumersPerTopic config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get maxConsumersPerTopic config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setMaxConsumersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Number of maximum consumers per topic", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "maxConsumersPerTopic value is not valid" } }, "summary": "Set maxConsumersPerTopic configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/maxProducersPerTopic": { "delete": { "operationId": "removeMaxProducersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxProducersPerTopic configuration on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getMaxProducersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxProducersPerTopic config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get maxProducersPerTopic config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setMaxProducersPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Number of maximum producers per topic", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "maxProducersPerTopic value is not valid" } }, "summary": "Set maxProducersPerTopic configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/maxSubscriptionsPerTopic": { "delete": { "operationId": "removeMaxSubscriptionsPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxSubscriptionsPerTopic configuration on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getMaxSubscriptionsPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxSubscriptionsPerTopic config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get maxSubscriptionsPerTopic config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setMaxSubscriptionsPerTopic", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Number of maximum subscriptions per topic", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "maxUnackedMessagesPerSubscription value is not valid" } }, "summary": "Set maxSubscriptionsPerTopic configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/maxTopicsPerNamespace": { "delete": { "operationId": "removeMaxTopicsPerNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Remove maxTopicsPerNamespace config on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getMaxTopicsPerNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxTopicsPerNamespace config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace does not exist" } }, "summary": "Get maxTopicsPerNamespace config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setMaxTopicsPerNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Number of maximum topics for specific namespace", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Set maxTopicsPerNamespace config on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerConsumer": { "delete": { "operationId": "removeMaxUnackedmessagesPerConsumer", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Remove maxUnackedMessagesPerConsumer config on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getMaxUnackedMessagesPerConsumer", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxUnackedMessagesPerConsumer config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get maxUnackedMessagesPerConsumer config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setMaxUnackedMessagesPerConsumer", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Number of maximum unacked messages per consumer", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "maxUnackedMessagesPerConsumer value is not valid" } }, "summary": "Set maxConsumersPerTopic configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/maxUnackedMessagesPerSubscription": { "delete": { "operationId": "removeMaxUnackedmessagesPerSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Remove maxUnackedMessagesPerSubscription config on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getMaxUnackedmessagesPerSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxUnackedMessagesPerSubscription config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get maxUnackedMessagesPerSubscription config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setMaxUnackedMessagesPerSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Number of maximum unacked messages per subscription", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "maxUnackedMessagesPerSubscription value is not valid" } }, "summary": "Set maxUnackedMessagesPerSubscription configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/messageTTL": { "delete": { "operationId": "removeNamespaceMessageTTL", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Invalid TTL" } }, "summary": "Remove message TTL in seconds for namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getNamespaceMessageTTL", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get the message TTL for the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get the message TTL for the namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "setNamespaceMessageTTL", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "TTL in seconds for the specified namespace", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Invalid TTL" } }, "summary": "Set message TTL in seconds for namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/offloadDeletionLagMs": { "delete": { "operationId": "clearOffloadDeletionLag", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Clear the namespace configured offload deletion lag. The topics in the namespace will fallback to using the default configured deletion lag for the broker", "tags": [ "namespaces" ] }, "get": { "description": "A negative value denotes that deletion has been completely disabled. 'null' denotes that the topics in the namespace will fall back to the broker default for deletion lag.", "operationId": "getOffloadDeletionLag", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" } }, "summary": "Number of milliseconds to wait before deleting a ledger segment which has been offloaded from the Pulsar cluster's local storage (i.e. BookKeeper)", "tags": [ "namespaces" ] }, "put": { "description": "A negative value disables the deletion completely.", "operationId": "setOffloadDeletionLag", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "New number of milliseconds to wait before deleting a ledger segment which has been offloaded", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "offloadDeletionLagMs value is not valid" } }, "summary": "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)", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/offloadPolicies": { "get": { "operationId": "getOffloadPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffloadPolicies" } } }, "description": "Get offload configuration on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get offload configuration on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setOffloadPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffloadPoliciesImpl" } } }, "description": "Offload policies for the specified namespace", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "OffloadPolicies is empty or driver is not supported or bucket is not valid" } }, "summary": "Set offload configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/offloadThreshold": { "get": { "description": "A negative value disables automatic offloading", "operationId": "getOffloadThreshold", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" } }, "summary": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", "tags": [ "namespaces" ] }, "put": { "description": "-1 will revert to using the cluster default. A negative value disables automatic offloading. ", "operationId": "setOffloadThreshold", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Maximum number of bytes stored on the pulsar cluster for a topic of the specified namespace", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "offloadThreshold value is not valid" } }, "summary": "Set maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/offloadThresholdInSeconds": { "get": { "description": "A negative value disables automatic offloading", "operationId": "getOffloadThresholdInSeconds", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" } }, "summary": "Maximum number of bytes stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", "tags": [ "namespaces" ] }, "put": { "description": "A negative value disables automatic offloading", "operationId": "setOffloadThresholdInSeconds", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } } }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "offloadThresholdInSeconds value is not valid" } }, "summary": "Set maximum number of seconds stored on the pulsar cluster for a topic, before the broker will start offloading to longterm storage", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/permissions": { "get": { "description": "Returns a map structure: Map>.", "operationId": "getPermissions", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "enum": [ "produce", "consume", "functions", "sources", "sinks", "packages" ], "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" } } }, "description": "Retrieve the permissions for a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Namespace is not empty" } }, "summary": "Retrieve the permissions for a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/permissions/subscription": { "get": { "description": "Returns a map structure: Map>.", "operationId": "getPermissionOnSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" } } }, "description": "Retrieve the permissions for a subscription." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Namespace is not empty" } }, "summary": "Retrieve the permissions for a subscription.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/permissions/{role}": { "delete": { "operationId": "revokePermissionsOnNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "role", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Revoke all permissions to a role on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "grantPermissionOnNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "role", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "enum": [ "produce", "consume", "functions", "sources", "sinks", "packages" ], "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "List of permissions for the specified role" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Concurrent modification" }, "501": { "description": "Authorization is not enabled" } }, "summary": "Grant a new permission to a role on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/persistence": { "delete": { "operationId": "deletePersistence", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Delete the persistence configuration for all topics on a namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getPersistence", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistencePolicies" } } }, "description": "Get the persistence configuration for a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Get the persistence configuration for a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setPersistence", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistencePolicies" } } }, "description": "Persistence policies for the specified namespace", "required": true }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid persistence policies" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Set the persistence configuration for all the topics on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/persistence/bookieAffinity": { "delete": { "operationId": "deleteBookieAffinityGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Delete the bookie-affinity-group from namespace-local policy.", "tags": [ "namespaces" ] }, "get": { "operationId": "getBookieAffinityGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookieAffinityGroupDataImpl" } } }, "description": "Get the bookie-affinity-group from namespace-local policy." }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Get the bookie-affinity-group from namespace-local policy.", "tags": [ "namespaces" ] }, "post": { "operationId": "setBookieAffinityGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookieAffinityGroupData" } } }, "description": "Bookie affinity group for the specified namespace" }, "responses": { "200": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Set the bookie-affinity-group to namespace-persistent policy.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/properties": { "delete": { "operationId": "clearProperties", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Clear properties on a given namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getProperties", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Get key value pair properties for a given namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Get key value pair properties for a given namespace.", "tags": [ "namespaces" ] }, "put": { "operationId": "setProperties", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Key value pair properties for the namespace", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Put key value pairs property on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/property/{key}": { "delete": { "operationId": "removeProperty", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Remove property value for a given key on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getProperty", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Get property value for a given key on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Get property value for a given key on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/property/{key}/{value}": { "put": { "operationId": "setProperty", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "value", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Put a key value pair property on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/removeOffloadPolicies": { "delete": { "operationId": "removeOffloadPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "OffloadPolicies is empty or driver is not supported or bucket is not valid" } }, "summary": "Set offload configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/replication": { "get": { "operationId": "getNamespaceReplicationClusters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the replication clusters for a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Namespace is not global" } }, "summary": "Get the replication clusters for a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setNamespaceReplicationClusters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "compareTopicPartitions", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "List of replication clusters", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Peer-cluster can't be part of replication-cluster" }, "412": { "description": "Namespace is not global or invalid cluster ids" } }, "summary": "Set the replication clusters for a namespace. When removing a cluster: with shared configuration store, data will be deleted from the removed cluster; with separate configuration store, only replication stops but data is preserved.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/replicatorDispatchRate": { "delete": { "operationId": "removeReplicatorDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Remove replicator dispatch-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getReplicatorDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Get replicator dispatch-rate configured for the namespace, null means replicator dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get replicator dispatch-rate configured for the namespace, null means replicator dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", "tags": [ "namespaces" ] }, "post": { "operationId": "setReplicatorDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Replicator dispatch rate for all topics of the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Set replicator dispatch-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/resourcegroup": { "delete": { "operationId": "removeNamespaceResourceGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Invalid resourcegroup" } }, "summary": "Delete resourcegroup for a namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getNamespaceResourceGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "Get the resource group attached to the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get the resource group attached to the namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/resourcegroup/{resourcegroup}": { "post": { "operationId": "setNamespaceResourceGroup", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "resourcegroup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Invalid resourcegroup" } }, "summary": "Set resourcegroup for a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/retention": { "delete": { "operationId": "removeRetention", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } }, "description": "Retention policies for the specified namespace" }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Retention Quota must exceed backlog quota" } }, "summary": "Remove retention configuration on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getRetention", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } }, "description": "Get retention config on a namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get retention config on a namespace.", "tags": [ "namespaces" ] }, "post": { "operationId": "setRetention", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } }, "description": "Retention policies for the specified namespace" }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Retention Quota must exceed backlog quota" } }, "summary": "Set retention configuration on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/scalableTopicAutoScalePolicy": { "delete": { "operationId": "removeScalableTopicAutoScalePolicy", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Remove the scalable-topic auto split/merge policy override from a namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getScalableTopicAutoScalePolicy", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScalePolicyOverride" } } }, "description": "The scalable-topic auto split/merge policy override for the namespace" }, "204": { "description": "No override is set on this namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Get the scalable-topic auto split/merge policy override for a namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "setScalableTopicAutoScalePolicy", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScalePolicyOverride" } } }, "description": "Auto split/merge policy override", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "The resolved auto split/merge policy violates an invariant" } }, "summary": "Override the broker's scalable-topic auto split/merge settings for a namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/scanOffloadedLedgers": { "get": { "operationId": "scanOffloadedLedgers", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": "{\"objects\":[{\"key1\":\"value1\",\"key2\":\"value2\"}],\"total\":100,\"errors\":5,\"unknown\":3}", "schema": { "type": "string" } } }, "description": "Successful get of offloaded ledger data" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" } }, "summary": "Trigger the scan of offloaded Ledgers on the LedgerOffloader for the given namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/schemaAutoUpdateCompatibilityStrategy": { "get": { "description": "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api", "operationId": "getSchemaAutoUpdateCompatibilityStrategy", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "enum": [ "AutoUpdateDisabled", "Backward", "Forward", "Full", "AlwaysCompatible", "BackwardTransitive", "ForwardTransitive", "FullTransitive" ], "type": "string" } } }, "description": "The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "The strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema", "tags": [ "namespaces" ] }, "put": { "description": "The value AutoUpdateDisabled prevents producers from updating the schema. If set to AutoUpdateDisabled, schemas must be updated through the REST api", "operationId": "setSchemaAutoUpdateCompatibilityStrategy", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "enum": [ "AutoUpdateDisabled", "Backward", "Forward", "Full", "AlwaysCompatible", "BackwardTransitive", "ForwardTransitive", "FullTransitive" ], "type": "string" } } }, "description": "Strategy used to check the compatibility of new schemas" }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Update the strategy used to check the compatibility of new schemas, provided by producers, before automatically updating the schema", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/schemaCompatibilityStrategy": { "get": { "operationId": "getSchemaCompatibilityStrategy", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "The strategy of the namespace schema compatibility " }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "The strategy of the namespace schema compatibility ", "tags": [ "namespaces" ] }, "put": { "operationId": "setSchemaCompatibilityStrategy", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "Strategy used to check the compatibility of new schema" }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Update the strategy used to check the compatibility of new schema", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/schemaValidationEnforced": { "get": { "description": "If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will fail to connect. PLEASE be careful when using this, since non-Java clients don't support schema. If you enable this setting, it will cause non-Java clients to fail to produce.", "operationId": "getSchemaValidtionEnforced", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get schema validation enforced flag for namespace." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenants or Namespace doesn't exist" } }, "summary": "Get schema validation enforced flag for namespace.", "tags": [ "namespaces" ] }, "post": { "description": "If the flag is set to true, when a producer without a schema attempts to produce to a topic with schema in this namespace, the producer will fail to connect. PLEASE be careful when using this, since non-Java clients don't support schema. If you enable this setting, it will cause non-Java clients to fail to produce.", "operationId": "setSchemaValidationEnforced", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Flag of whether validation is enforced on the specified namespace", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or Namespace doesn't exist" }, "412": { "description": "schemaValidationEnforced value is not valid" } }, "summary": "Set schema validation enforced flag on namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/subscribeRate": { "delete": { "operationId": "deleteSubscribeRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Delete subscribe-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getSubscribeRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Get subscribe-rate configured for the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get subscribe-rate configured for the namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "setSubscribeRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Subscribe rate for all topics of the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Set subscribe-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/subscriptionAuthMode": { "get": { "operationId": "getSubscriptionAuthMode", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "enum": [ "None", "Prefix" ], "type": "string" } } }, "description": "Get subscription auth mode in a namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" } }, "summary": "Get subscription auth mode in a namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "setSubscriptionAuthMode", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "enum": [ "None", "Prefix" ], "type": "string" } } }, "description": "Subscription auth mode for all topics of the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Set a subscription auth mode for all the topics on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/subscriptionDispatchRate": { "delete": { "operationId": "deleteSubscriptionDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Delete Subscription dispatch-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getSubscriptionDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get subscription dispatch-rate configured for the namespace, null means subscription dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get subscription dispatch-rate configured for the namespace, null means subscription dispatch-rate not configured, -1 means msg-dispatch-rate or byte-dispatch-rate not configured in dispatch-rate yet", "tags": [ "namespaces" ] }, "post": { "operationId": "setSubscriptionDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Subscription dispatch rate for all topics of the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" } }, "summary": "Set Subscription dispatch-rate throttling for all topics of the namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/subscriptionExpirationTime": { "delete": { "operationId": "removeSubscriptionExpirationTime", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Remove subscription expiration time for namespace", "tags": [ "namespaces" ] }, "get": { "operationId": "getSubscriptionExpirationTime", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get the subscription expiration time for the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get the subscription expiration time for the namespace", "tags": [ "namespaces" ] }, "post": { "operationId": "setSubscriptionExpirationTime", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Expiration time in minutes for the specified namespace", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "412": { "description": "Invalid expiration time" } }, "summary": "Set subscription expiration time in minutes for namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/subscriptionTypesEnabled": { "delete": { "operationId": "removeSubscriptionTypesEnabled", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or Namespace does not exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove subscription types enabled on a namespace.", "tags": [ "namespaces" ] }, "get": { "operationId": "getSubscriptionTypesEnabled", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "enum": [ "Exclusive", "Shared", "Failover", "Key_Shared" ], "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "The set of enabled subscription types" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "The set of enabled subscription types", "tags": [ "namespaces" ] }, "post": { "operationId": "setSubscriptionTypesEnabled", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "enum": [ "Exclusive", "Shared", "Failover", "Key_Shared" ], "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Set of enabled subscription types", "required": true }, "responses": { "200": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "409": { "description": "Concurrent modification" } }, "summary": "Update the set of enabled subscription types", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/topics": { "get": { "operationId": "getTopics", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "mode", "schema": { "default": "PERSISTENT", "enum": [ "PERSISTENT", "NON_PERSISTENT", "ALL" ], "type": "string" } }, { "description": "Include system topic", "in": "query", "name": "includeSystemTopic", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the list of all the topics under a certain namespace." }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" } }, "summary": "Get the list of all the topics under a certain namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/unload": { "put": { "description": "Unload an active namespace from the current broker serving it. Performing this operation will make the broker remove all producers, consumers, and connections using this namespace, and close all topics (including their persistent store). During that operation, the namespace is marked as tentatively unavailable until the broker completes the unloading action. This operation requires strictly super user privileges, since it would result in non-persistent message loss and unexpected connection closure to the clients.", "operationId": "unloadNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" }, "412": { "description": "Namespace is already unloaded or Namespace has bundles activated" } }, "summary": "Unload namespace", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/unsubscribe/{subscription}": { "post": { "operationId": "unsubscribeNamespace", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "Namespace does not exist" } }, "summary": "Unsubscribes the given subscription on all topics on a namespace.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/{bundle}": { "delete": { "operationId": "deleteNamespaceBundle", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace doesn't exist" }, "409": { "description": "Namespace bundle is not empty" } }, "summary": "Delete a namespace bundle and all the topics under it.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog": { "post": { "operationId": "clearNamespaceBundleBacklog", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "Namespace does not exist" } }, "summary": "Clear backlog for all topics on a namespace bundle.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/{bundle}/clearBacklog/{subscription}": { "post": { "operationId": "clearNamespaceBundleBacklogForSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "Namespace does not exist" } }, "summary": "Clear backlog for a given subscription on all topics on a namespace bundle.", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/{bundle}/split": { "put": { "operationId": "splitNamespaceBundle", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "unload", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "splitAlgorithmName", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "format": "int64", "type": "integer" }, "type": "array" } } }, "description": "splitBoundaries" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" } }, "summary": "Split a namespace bundle", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/{bundle}/topicHashPositions": { "get": { "operationId": "getTopicHashPositions", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "topics", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicHashPositions" } } }, "description": "Get hash positions for topics" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get hash positions for topics", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/{bundle}/unload": { "put": { "operationId": "unloadNamespaceBundle", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "destinationBroker", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" } }, "summary": "Unload a namespace bundle", "tags": [ "namespaces" ] } }, "/admin/v2/namespaces/{tenant}/{namespace}/{bundle}/unsubscribe/{subscription}": { "post": { "operationId": "unsubscribeNamespaceBundle", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "Namespace does not exist" } }, "summary": "Unsubscribes the given subscription on all topics on a namespace bundle.", "tags": [ "namespaces" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}": { "get": { "operationId": "getList_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the bundle name", "in": "query", "name": "bundle", "schema": { "type": "string" } }, { "description": "Include system topic", "in": "query", "name": "includeSystemTopic", "schema": { "type": "boolean" } }, { "description": "properties for customized topic listing plugin, format: k1=v1,k2=v2", "in": "query", "name": "properties", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of topics under a namespace." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Namespace name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the list of non-persistent topics under a namespace.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/partitioned": { "get": { "operationId": "getPartitionedTopicList_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Include system topic", "in": "query", "name": "includeSystemTopic", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of partitioned topics under a namespace." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Namespace name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Get the list of partitioned topics under a namespace.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{bundle}": { "get": { "operationId": "getListFromBundle", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Bundle range of a topic", "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of non-persistent topics under a namespace bundle." }, "401": { "description": "Don't have permission to manage resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace doesn't exist" }, "412": { "description": "Namespace name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the list of non-persistent topics under a namespace bundle.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}": { "delete": { "description": "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.", "operationId": "deleteTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Stop all producer/consumer/replicator and delete topic forcefully", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic has active producers/subscriptions" }, "500": { "description": "Internal server error" } }, "summary": "Delete a topic.", "tags": [ "non-persistent topic" ] }, "put": { "description": "This is the only REST endpoint from which non-partitioned topics could be created.", "operationId": "createNonPartitionedTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Key value pair properties for the topic metadata" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" }, "409": { "description": "Partitioned topic already exists" }, "412": { "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Create a non-partitioned topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}": { "post": { "operationId": "expireMessagesForAllSubscriptions_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Expires beyond the specified number of seconds", "in": "path", "name": "expireTimeInSeconds", "required": true, "schema": { "default": 0, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Expiring messages on a non-persistent topic is not allowed" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Expire messages on all subscriptions of a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/autoSubscriptionCreation": { "delete": { "operationId": "removeAutoSubscriptionCreation_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic does not exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove autoSubscriptionCreation in a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getAutoSubscriptionCreation_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoSubscriptionCreationOverrideImpl" } } }, "description": "Get autoSubscriptionCreation info in a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic does not exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get autoSubscriptionCreation info in a topic", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setAutoSubscriptionCreation_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutoSubscriptionCreationOverrideImpl" } } }, "description": "Settings for automatic subscription creation" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Override namespace's allowAutoSubscriptionCreation setting for a topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/backlog": { "get": { "operationId": "getBacklog_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistentOfflineTopicStats" } } }, "description": "Get estimated backlog for offline topic." }, "404": { "description": "Namespace does not exist" }, "412": { "description": "Topic name is not valid" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get estimated backlog for offline topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/backlogQuota": { "delete": { "operationId": "removeBacklogQuota_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "backlogQuotaType", "schema": { "enum": [ "destination_storage", "message_age" ], "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove a backlog quota policy from a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setBacklogQuota_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "backlogQuotaType", "schema": { "enum": [ "destination_storage", "message_age" ], "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BacklogQuotaImpl" } } }, "description": "backlog quota policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" } }, "summary": "Set a backlog quota for a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap": { "get": { "operationId": "getBacklogQuotaMap_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/BacklogQuota" }, "type": "object" } } }, "description": "Get backlog quota map on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic policy or namespace does not exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" } }, "summary": "Get backlog quota map on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/backlogSize": { "put": { "operationId": "getBacklogSizeByMessageId_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MessageIdImpl" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Calculate backlog size by a message ID (in bytes)." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Calculate backlog size by a message ID (in bytes).", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/compaction": { "get": { "operationId": "compactionStatus_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongRunningProcessStatus" } } }, "description": "Get the status of a compaction operation for a topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist, or compaction hasn't run" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the status of a compaction operation for a topic.", "tags": [ "non-persistent topic" ] }, "put": { "operationId": "compact_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "409": { "description": "Compaction already running" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Trigger a compaction operation on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/compactionThreshold": { "delete": { "operationId": "removeCompactionThreshold_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove compaction threshold configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getCompactionThreshold_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Get compaction threshold configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get compaction threshold configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setCompactionThreshold_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set compaction threshold configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/createMissedPartitions": { "post": { "operationId": "createMissedPartitions_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant does not exist" }, "409": { "description": "Partitioned topic does not exist" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Create missed partitions of an existing partitioned topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled": { "delete": { "operationId": "removeDeduplication_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove deduplication configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getDeduplication_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get deduplication configuration of a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" } }, "summary": "Get deduplication configuration of a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setDeduplication_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "description": "DeduplicationEnabled policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" } }, "summary": "Set deduplication enabled on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval": { "delete": { "operationId": "deleteDeduplicationSnapshotInterval_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete deduplicationSnapshotInterval config on a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getDeduplicationSnapshotInterval_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get deduplicationSnapshotInterval config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get deduplicationSnapshotInterval config on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setDeduplicationSnapshotInterval_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Interval to take deduplication snapshot for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set deduplicationSnapshotInterval config on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/delayedDelivery": { "delete": { "operationId": "deleteDelayedDeliveryPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set delayed delivery messages config on a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getDelayedDeliveryPolicies_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelayedDeliveryPolicies" } } }, "description": "Get delayed delivery messages config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get delayed delivery messages config on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setDelayedDeliveryPolicies_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DelayedDeliveryPolicies" } } }, "description": "Delayed delivery policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set delayed delivery messages config on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/dispatchRate": { "delete": { "operationId": "removeDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove message dispatch rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getDispatchRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Get dispatch rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get dispatch rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setDispatchRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set message dispatch rate configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent": { "delete": { "operationId": "removeDispatcherPauseOnAckStatePersistent_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove dispatcher pause on ack state persistent configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getDispatcherPauseOnAckStatePersistent_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get dispatcher pause on ack state persistent config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get dispatcher pause on ack state persistent config on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setDispatcherPauseOnAckStatePersistent_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set dispatcher pause on ack state persistent configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/entryFilters": { "delete": { "operationId": "removeEntryFilters_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove entry filters for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getEntryFilters_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryFilters" } } }, "description": "Get entry filters for a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenants or Namespace doesn't exist" } }, "summary": "Get entry filters for a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setEntryFilters_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EntryFilters" } } }, "description": "Entry filters for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set entry filters for specified topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/examinemessage": { "get": { "operationId": "examineMessage_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Relative start position to examine message. It can be 'latest' or 'earliest'", "in": "query", "name": "initialPosition", "schema": { "default": "latest", "enum": [ "latest", "earliest" ], "type": "string" } }, { "description": "The position of messages (default 1)", "in": "query", "name": "messagePosition", "schema": { "default": 1, "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic, the message position does not exist" }, "405": { "description": "If given partitioned topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Examine a specific message on a topic by position relative to the earliest or the latest message.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies": { "delete": { "operationId": "deleteInactiveTopicPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete inactive topic policies on a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getInactiveTopicPolicies_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InactiveTopicPolicies" } } }, "description": "Get inactive topic policies on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get inactive topic policies on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setInactiveTopicPolicies_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InactiveTopicPolicies" } } }, "description": "inactive topic policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set inactive topic policies on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/internal-info": { "get": { "operationId": "getManagedLedgerInfo_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedManagedLedgerInfo" } } }, "description": "Get the stored topic metadata." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stored topic metadata.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/internalStats": { "get": { "operationId": "getInternalStats_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "metadata", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistentTopicInternalStats" } } }, "description": "Get the internal stats for the topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the internal stats for the topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/lastMessageId": { "get": { "operationId": "getLastMessageId_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageIdAdv" } } }, "description": "Return the last commit message id of topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Return the last commit message id of topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}": { "get": { "operationId": "getMessageById_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "The ledger id", "in": "path", "name": "ledgerId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "The entry id", "in": "path", "name": "entryId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic, subscription or the message position does not exist" }, "405": { "description": "Skipping messages on a non-persistent topic is not allowed" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get message by its messageId.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/maxConsumers": { "delete": { "operationId": "removeMaxConsumers_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxConsumers config for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMaxConsumers_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxConsumers config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxConsumers config for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMaxConsumers_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max consumers of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxConsumers" } }, "summary": "Set maxConsumers config for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription": { "delete": { "operationId": "removeMaxConsumersPerSubscription_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove max consumers per subscription configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMaxConsumersPerSubscription_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get max consumers per subscription configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get max consumers per subscription configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMaxConsumersPerSubscription_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set max consumers per subscription configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/maxMessageSize": { "delete": { "operationId": "removeMaxMessageSize_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxMessageSize config for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMaxMessageSize_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxMessageSize config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxMessageSize config for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMaxMessageSize_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max message size of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxConsumers" } }, "summary": "Set maxMessageSize config for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/maxProducers": { "delete": { "operationId": "removeMaxProducers_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxProducers config for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMaxProducers_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxProducers config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxProducers config for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMaxProducers_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max producers of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxProducers" } }, "summary": "Set maxProducers config for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic": { "delete": { "operationId": "removeMaxSubscriptionsPerTopic_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxSubscriptionsPerTopic config for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMaxSubscriptionsPerTopic_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxSubscriptionsPerTopic config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxSubscriptionsPerTopic config for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMaxSubscriptionsPerTopic_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max subscriptions of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxSubscriptionsPerTopic" } }, "summary": "Set maxSubscriptionsPerTopic config for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer": { "delete": { "operationId": "deleteMaxUnackedMessagesOnConsumer_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete max unacked messages per consumer config on a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMaxUnackedMessagesOnConsumer_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get max unacked messages per consumer config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get max unacked messages per consumer config on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMaxUnackedMessagesOnConsumer_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Max unacked messages on consumer policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set max unacked messages per consumer config on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription": { "delete": { "operationId": "deleteMaxUnackedMessagesOnSubscription_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete max unacked messages per subscription config on a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMaxUnackedMessagesOnSubscription_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get max unacked messages per subscription config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get max unacked messages per subscription config on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMaxUnackedMessagesOnSubscription_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Max unacked messages on subscription policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set max unacked messages per subscription config on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/messageTTL": { "delete": { "operationId": "removeMessageTTL_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Not authenticate to perform the request or policy is read only" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid message TTL value" } }, "summary": "Remove message TTL in seconds for a topic", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getMessageTTL_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get message TTL in seconds for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get message TTL in seconds for a topic", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setMessageTTL_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "TTL in seconds for the specified topic", "in": "query", "name": "messageTTL", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Not authenticate to perform the request or policy is read only" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid message TTL value" } }, "summary": "Set message TTL in seconds for a topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/messageid/{timestamp}": { "get": { "operationId": "getMessageIdByTimestamp_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Specify the timestamp", "in": "path", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageIdAdv" } } }, "description": "Get message ID published at or just after this absolute timestamp (in ms)." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Topic is not non-partitioned and persistent" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get message ID published at or just after this absolute timestamp (in ms).", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/offload": { "get": { "operationId": "offloadStatus_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffloadProcessStatus" } } }, "description": "Offload a prefix of a topic to long term storage" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Offload a prefix of a topic to long term storage", "tags": [ "non-persistent topic" ] }, "put": { "operationId": "triggerOffload_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MessageIdImpl" } } } }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "400": { "description": "Message ID is null" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "409": { "description": "Offload already running" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Offload a prefix of a topic to long term storage", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/offloadPolicies": { "delete": { "operationId": "removeOffloadPolicies_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete offload policies on a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getOffloadPolicies_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffloadPoliciesImpl" } } }, "description": "Get offload policies on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get offload policies on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setOffloadPolicies_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OffloadPoliciesImpl" } } }, "description": "Offload policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set offload policies on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/partitioned-internalStats": { "get": { "operationId": "getPartitionedStatsInternal_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicInternalStats" } } }, "description": "Get the stats-internal for the partitioned topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stats-internal for the partitioned topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/partitioned-stats": { "get": { "operationId": "getPartitionedStats_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Get per partition stats", "in": "query", "name": "perPartition", "schema": { "default": true, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "If return precise backlog or imprecise backlog", "in": "query", "name": "getPreciseBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", "in": "query", "name": "subscriptionBacklogSize", "schema": { "default": false, "type": "boolean" } }, { "description": "If return the earliest time in backlog", "in": "query", "name": "getEarliestTimeInBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the publishers", "in": "query", "name": "excludePublishers", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the consumers", "in": "query", "name": "excludeConsumers", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicStatsImpl" } } }, "description": "Get the stats for the partitioned topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stats for the partitioned topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/partitions": { "delete": { "description": "It will also delete all the partitions of the topic if it exists.", "operationId": "deletePartitionedTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Stop all producer/consumer/replicator and delete topic forcefully", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Partitioned topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Delete a partitioned topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getPartitionedMetadata_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "Is check configuration required to automatically create topic", "in": "query", "name": "checkAllowAutoCreation", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicMetadata" } } }, "description": "Get partitioned topic metadata." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Partitioned topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate cluster configuration" } }, "summary": "Get partitioned topic metadata.", "tags": [ "non-persistent topic" ] }, "post": { "description": "It increments the partitions of an existing partitioned topic.", "operationId": "updatePartitionedTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateLocalTopicOnly", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "default": "0", "type": "integer" } } }, "description": "The number of partitions for the topic", "required": true }, "responses": { "204": { "description": "Update topic partition successful." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden/Unauthorized" }, "404": { "description": "Topic does not exist" }, "412": { "description": "Partitioned topic name is invalid" }, "422": { "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic and number of new partitions must be greater than existing number of partitions" }, "500": { "description": "Internal server error" } }, "summary": "Increment partitions of an existing partitioned topic.", "tags": [ "non-persistent topic" ] }, "put": { "description": "It needs to be called before creating a producer on a partitioned topic.", "operationId": "createPartitionedTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "createLocalTopicOnly", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "default": "0", "type": "integer" } }, "application/vnd.partitioned-topic-metadata+json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicMetadata" } } }, "description": "The number of partitions for the topic, or the partitioned topic metadata (partitions and properties) when the request is sent with the 'application/vnd.partitioned-topic-metadata+json' content type", "required": true }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" }, "406": { "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic" }, "409": { "description": "Partitioned topic already exists" }, "412": { "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Create a partitioned topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/permissions": { "get": { "description": "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. Returns a map structure: Map>.", "operationId": "getPermissionsOnTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "enum": [ "produce", "consume", "functions", "sources", "sinks", "packages" ], "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" } } }, "description": "Get permissions on a topic." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Get permissions on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/permissions/{role}": { "delete": { "description": "Revoke permissions to a 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).", "operationId": "revokePermissionsOnTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Client role to which grant permissions", "in": "path", "name": "role", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Permissions are not set at the topic level" }, "500": { "description": "Internal server error" } }, "summary": "Revoke permissions on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "grantPermissionsOnTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Client role to which grant permissions", "in": "path", "name": "role", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "enum": [ "produce", "functions", "consume" ], "type": "string" } } }, "description": "Actions to be granted (produce,functions,consume)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Grant a new permission to a role on a single topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/persistence": { "delete": { "operationId": "removePersistence_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove configuration of persistence policies for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getPersistence_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistencePolicies" } } }, "description": "Get configuration of persistence policies for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get configuration of persistence policies for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setPersistence_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersistencePolicies" } } }, "description": "Bookkeeper persistence policies for specified topic" }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid persistence policies" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set configuration of persistence policies for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/policies": { "delete": { "operationId": "deleteTopicPolicies_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "500": { "description": "Internal server error" } }, "summary": "Delete policies for a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/properties": { "delete": { "operationId": "removeProperties_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "key", "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Partitioned topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Remove the key in properties on the given topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getProperties_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Get topic properties." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Get topic properties.", "tags": [ "non-persistent topic" ] }, "put": { "operationId": "updateProperties_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Key value pair properties for the topic metadata" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Update the properties on the given topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/publishRate": { "delete": { "operationId": "removePublishRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove message publish rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getPublishRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishRate" } } }, "description": "Get publish rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get publish rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setPublishRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PublishRate" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set message publish rate configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/replication": { "delete": { "operationId": "removeReplicationClusters_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove the replication clusters from a topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getReplicationClusters_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the replication clusters for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get the replication clusters for a topic", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setReplicationClusters_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "List of replication clusters", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic is not global or invalid cluster ids" } }, "summary": "Set the replication clusters for a topic. When removing a cluster: with shared configuration store, topic data will be deleted from the removed cluster; with separate configuration store, only replication stops but topic data is preserved.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate": { "delete": { "operationId": "removeReplicatorDispatchRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove replicatorDispatchRate config for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getReplicatorDispatchRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get replicatorDispatchRate config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get replicatorDispatchRate config for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setReplicatorDispatchRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Replicator dispatch rate of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of replicatorDispatchRate" } }, "summary": "Set replicatorDispatchRate config for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/retention": { "delete": { "operationId": "removeRetention_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Retention Quota must exceed backlog quota" } }, "summary": "Remove retention configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getRetention_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } }, "description": "Get retention configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get retention configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setRetention_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } }, "description": "Retention policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Retention Quota must exceed backlog quota" } }, "summary": "Set retention configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/schemaCompatibilityStrategy": { "delete": { "operationId": "removeSchemaCompatibilityStrategy_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "Strategy used to check the compatibility of new schema" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Operation not allowed on persistent topic" } }, "summary": "Remove schema compatibility strategy on a topic", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getSchemaCompatibilityStrategy_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the cluster", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "Get schema compatibility strategy on a topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Operation not allowed on persistent topic" } }, "summary": "Get schema compatibility strategy on a topic", "tags": [ "non-persistent topic" ] }, "put": { "operationId": "setSchemaCompatibilityStrategy_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "Strategy used to check the compatibility of new schema" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Operation not allowed on persistent topic" } }, "summary": "Set schema compatibility strategy on a topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/schemaValidationEnforced": { "get": { "operationId": "getSchemaValidationEnforced_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get schema validation enforced flag for topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenants or Namespace doesn't exist" } }, "summary": "Get schema validation enforced flag for topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setSchemaValidationEnforced_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or Namespace doesn't exist" }, "412": { "description": "schemaValidationEnforced value is not valid" } }, "summary": "Set schema validation enforced flag on topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/shadowTopics": { "delete": { "operationId": "deleteShadowTopics_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Delete shadow topics for a topic", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getShadowTopics_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the shadow topic list for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get the shadow topic list for a topic", "tags": [ "non-persistent topic" ] }, "put": { "operationId": "setShadowTopics_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "List of shadow topics", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set shadow topic list for a topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/stats": { "get": { "operationId": "getStats_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "If return precise backlog or imprecise backlog", "in": "query", "name": "getPreciseBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", "in": "query", "name": "subscriptionBacklogSize", "schema": { "default": true, "type": "boolean" } }, { "description": "If return time of the earliest message in backlog", "in": "query", "name": "getEarliestTimeInBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the publishers", "in": "query", "name": "excludePublishers", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the consumers", "in": "query", "name": "excludeConsumers", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistentTopicStats" } } }, "description": "Get the stats for the topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stats for the topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscribeRate": { "delete": { "operationId": "removeSubscribeRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Subscribe rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove subscribe rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getSubscribeRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Get subscribe rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get subscribe rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setSubscribeRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Subscribe rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set subscribe rate configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}": { "delete": { "description": "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.", "operationId": "deleteSubscription_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to be deleted", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Disconnect and close all consumers and delete subscription forcefully", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "412": { "description": "Subscription has active consumers" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Delete a subscription.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/analyzeBacklog": { "post": { "operationId": "analyzeSubscriptionBacklog_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResetCursorData" } } }, "description": "messageId to start the analysis" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Analyse a subscription, by scanning all the unprocessed messages", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages": { "post": { "operationId": "expireTopicMessages_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to expire messages on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResetCursorData" } } }, "description": "messageId to reset back to (ledgerId:entryId)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Expiring messages on a non-persistent topic is not allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Expire messages on a topic subscription.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}": { "post": { "operationId": "expireTopicMessages_3", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to expire messages on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Expires beyond the specified number of seconds", "in": "path", "name": "expireTimeInSeconds", "required": true, "schema": { "default": 0, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Expiring messages on a non-persistent topic is not allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Expire messages on a topic subscription.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}": { "get": { "operationId": "peekNthMessage_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscribed message expired", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "The number of messages (default 1)", "in": "path", "name": "messagePosition", "required": true, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic, subscription or the message position does not exist" }, "405": { "description": "Skipping messages on a non-persistent topic is not allowed" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Peek nth message on a topic subscription.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/properties": { "get": { "operationId": "getSubscriptionProperties_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Return all the properties on the given subscription" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Return all the properties on the given subscription", "tags": [ "non-persistent topic" ] }, "put": { "operationId": "updateSubscriptionProperties_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to update", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "The new properties" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Replace all the properties on the given subscription", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus": { "get": { "operationId": "getReplicatedSubscriptionStatus_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "boolean" }, "type": "object" } } }, "description": "Get replicated subscription status on a topic." }, "401": { "description": "Don't have permission to administrate resources" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" } }, "summary": "Get replicated subscription status on a topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setReplicatedSubscriptionStatus_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "description": "Whether to enable replicated subscription", "required": true }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic or subscription does not exist" }, "405": { "description": "Operation not allowed on this topic" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Enable or disable a replicated subscription on a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor": { "post": { "description": "It fences the cursor and disconnects all active consumers before resetting the cursor.", "operationId": "resetCursorOnPosition_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to reset position on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResetCursorData" } } }, "description": "messageId to reset back to (ledgerId:entryId)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Not supported for partitioned topics" }, "412": { "description": "Unable to find position for position specified" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Reset subscription to message position closest to given position.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}": { "post": { "description": "It fences the cursor and disconnects all active consumers before resetting the cursor.", "operationId": "resetCursor_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to reset position on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "the timestamp to reset back", "in": "path", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "412": { "description": "Failed to reset cursor on subscription or Unable to find position for timestamp specified" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Reset subscription to message position closest to absolute timestamp (in ms).", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}": { "post": { "operationId": "skipMessages_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "The number of messages to skip", "in": "path", "name": "numMessages", "required": true, "schema": { "default": 0, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Skipping messages on a partitioned topic is not allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Skipping messages on a topic subscription.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all": { "post": { "description": "Completely clears the backlog on the subscription.", "operationId": "skipAllMessages_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Operation not allowed on non-persistent topic" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Skip all messages on a topic subscription.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}": { "put": { "description": "Creates a subscription on the topic at the specified message id", "operationId": "createSubscription_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription to be created", "in": "path", "name": "subscriptionName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "Is replicated required to perform this operation", "in": "query", "name": "replicated", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "default": "latest", "enum": [ "latest", "earliest", "ledgerId:entryId" ], "type": "string" } } }, "description": "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "400": { "description": "Creating a subscription on a non-persistent topic is not supported" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Not supported for partitioned topics" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Create a subscription on the topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate": { "delete": { "operationId": "removeSubscriptionDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove subscription message dispatch rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getSubscriptionDispatchRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get subscription message dispatch rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get subscription message dispatch rate configuration for specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setSubscriptionDispatchRate_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Subscription message dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set subscription message dispatch rate configuration for specified topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscriptionExpirationTime": { "delete": { "operationId": "removeSubscriptionExpirationTime_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid subscription expiration time value" } }, "summary": "Remove subscription expiration time for a topic", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getSubscriptionExpirationTime_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get subscription expiration time in minutes for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get subscription expiration time in minutes for a topic", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setSubscriptionExpirationTime_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription expiration time in minutes", "in": "query", "name": "subscriptionExpirationTime", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid subscription expiration time value" } }, "summary": "Set subscription expiration time in minutes for a topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled": { "delete": { "operationId": "removeSubscriptionTypesEnabled_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove subscription types enabled for specified topic.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getSubscriptionTypesEnabled_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "enum": [ "Exclusive", "Shared", "Failover", "Key_Shared" ], "type": "string" }, "type": "array" } } }, "description": "Get the enabled subscription types for the specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get the enabled subscription types for the specified topic.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setSubscriptionTypesEnabled_2", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "items": { "enum": [ "Exclusive", "Shared", "Failover", "Key_Shared" ], "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Enable sub types for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set the enabled subscription types for the specified topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/subscriptions": { "get": { "operationId": "getSubscriptions_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of persistent subscriptions for a given topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the list of persistent subscriptions for a given topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/terminate": { "post": { "operationId": "terminate_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageIdAdv" } } }, "description": "Operation terminated successfully. The response includes the 'lastMessageId', which is the identifier of the last message processed." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Termination of a partitioned topic is not allowed" }, "406": { "description": "Need to provide a persistent topic name" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "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", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/terminate/partitions": { "post": { "operationId": "terminatePartitionedTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Termination of a non-partitioned topic is not allowed" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Terminate all partitioned 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", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/trim": { "post": { "operationId": "trimTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": " Trim a topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/truncate": { "delete": { "description": "NonPersistentTopic does not support truncate.", "operationId": "truncateTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "NonPersistentTopic does not support truncate." }, "500": { "description": "Internal server error" } }, "summary": "Truncate a topic.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/unload": { "put": { "operationId": "unloadTopic_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic name is not valid or can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Unload a topic", "tags": [ "non-persistent topic" ] } }, "/admin/v2/non-persistent/{tenant}/{namespace}/{topic}/{subName}/dispatchRate": { "delete": { "operationId": "removeSubscriptionLevelDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove message dispatch rate configuration for specified subscription.", "tags": [ "non-persistent topic" ] }, "get": { "operationId": "getSubscriptionLevelDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get message dispatch rate configuration for specified subscription." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get message dispatch rate configuration for specified subscription.", "tags": [ "non-persistent topic" ] }, "post": { "operationId": "setSubscriptionLevelDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Subscription message dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set message dispatch rate configuration for specified subscription.", "tags": [ "non-persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}": { "get": { "operationId": "getList", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the bundle name", "in": "query", "name": "bundle", "schema": { "type": "string" } }, { "description": "Include system topic", "in": "query", "name": "includeSystemTopic", "schema": { "type": "boolean" } }, { "description": "properties for customized topic listing plugin, format: k1=v1,k2=v2", "in": "query", "name": "properties", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of topics under a namespace." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Namespace name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Get the list of topics under a namespace.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/partitioned": { "get": { "operationId": "getPartitionedTopicList", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Include system topic", "in": "query", "name": "includeSystemTopic", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of partitioned topics under a namespace." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin or operate permission on the namespace" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Namespace name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Get the list of partitioned topics under a namespace.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}": { "delete": { "description": "The topic cannot be deleted if delete is not forcefully and there's any active subscription or producer connected to the it. Force delete ignores connected clients and deletes topic by explicitly closing them.", "operationId": "deleteTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Stop all producer/consumer/replicator and delete topic forcefully", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic has active producers/subscriptions" }, "500": { "description": "Internal server error" } }, "summary": "Delete a topic.", "tags": [ "persistent topic" ] }, "put": { "description": "This is the only REST endpoint from which non-partitioned topics could be created.", "operationId": "createNonPartitionedTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Key value pair properties for the topic metadata" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" }, "409": { "description": "Partitioned topic already exists" }, "412": { "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Create a non-partitioned topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/all_subscription/expireMessages/{expireTimeInSeconds}": { "post": { "operationId": "expireMessagesForAllSubscriptions", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Expires beyond the specified number of seconds", "in": "path", "name": "expireTimeInSeconds", "required": true, "schema": { "default": 0, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Expiring messages on a non-persistent topic is not allowed" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Expire messages on all subscriptions of a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/autoSubscriptionCreation": { "delete": { "operationId": "removeAutoSubscriptionCreation_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic does not exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove autoSubscriptionCreation in a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getAutoSubscriptionCreation_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoSubscriptionCreationOverrideImpl" } } }, "description": "Get autoSubscriptionCreation info in a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic does not exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get autoSubscriptionCreation info in a topic", "tags": [ "persistent topic" ] }, "post": { "operationId": "setAutoSubscriptionCreation_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutoSubscriptionCreationOverrideImpl" } } }, "description": "Settings for automatic subscription creation" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Override namespace's allowAutoSubscriptionCreation setting for a topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/backlog": { "get": { "operationId": "getBacklog", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistentOfflineTopicStats" } } }, "description": "Get estimated backlog for offline topic." }, "404": { "description": "Namespace does not exist" }, "412": { "description": "Topic name is not valid" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get estimated backlog for offline topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/backlogQuota": { "delete": { "operationId": "removeBacklogQuota_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "backlogQuotaType", "schema": { "enum": [ "destination_storage", "message_age" ], "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove a backlog quota policy from a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setBacklogQuota_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "backlogQuotaType", "schema": { "enum": [ "destination_storage", "message_age" ], "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BacklogQuotaImpl" } } }, "description": "backlog quota policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Specified backlog quota exceeds retention quota. Increase retention quota and retry request" } }, "summary": "Set a backlog quota for a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/backlogQuotaMap": { "get": { "operationId": "getBacklogQuotaMap_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/BacklogQuota" }, "type": "object" } } }, "description": "Get backlog quota map on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic policy or namespace does not exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" } }, "summary": "Get backlog quota map on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/backlogSize": { "put": { "operationId": "getBacklogSizeByMessageId", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MessageIdImpl" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Calculate backlog size by a message ID (in bytes)." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Calculate backlog size by a message ID (in bytes).", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/compaction": { "get": { "operationId": "compactionStatus", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongRunningProcessStatus" } } }, "description": "Get the status of a compaction operation for a topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist, or compaction hasn't run" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the status of a compaction operation for a topic.", "tags": [ "persistent topic" ] }, "put": { "operationId": "compact", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "409": { "description": "Compaction already running" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Trigger a compaction operation on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/compactionThreshold": { "delete": { "operationId": "removeCompactionThreshold", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove compaction threshold configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getCompactionThreshold_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Get compaction threshold configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get compaction threshold configuration for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setCompactionThreshold_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int64", "type": "integer" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set compaction threshold configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/createMissedPartitions": { "post": { "operationId": "createMissedPartitions", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant does not exist" }, "409": { "description": "Partitioned topic does not exist" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Create missed partitions of an existing partitioned topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/deduplicationEnabled": { "delete": { "operationId": "removeDeduplication_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove deduplication configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getDeduplication_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get deduplication configuration of a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" } }, "summary": "Get deduplication configuration of a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setDeduplication", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "description": "DeduplicationEnabled policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" } }, "summary": "Set deduplication enabled on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/deduplicationSnapshotInterval": { "delete": { "operationId": "deleteDeduplicationSnapshotInterval", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete deduplicationSnapshotInterval config on a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getDeduplicationSnapshotInterval_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get deduplicationSnapshotInterval config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get deduplicationSnapshotInterval config on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setDeduplicationSnapshotInterval_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Interval to take deduplication snapshot for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set deduplicationSnapshotInterval config on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/delayedDelivery": { "delete": { "operationId": "deleteDelayedDeliveryPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set delayed delivery messages config on a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getDelayedDeliveryPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DelayedDeliveryPolicies" } } }, "description": "Get delayed delivery messages config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get delayed delivery messages config on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setDelayedDeliveryPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DelayedDeliveryPolicies" } } }, "description": "Delayed delivery policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set delayed delivery messages config on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/dispatchRate": { "delete": { "operationId": "removeDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove message dispatch rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Get dispatch rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get dispatch rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set message dispatch rate configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent": { "delete": { "operationId": "removeDispatcherPauseOnAckStatePersistent_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove dispatcher pause on ack state persistent configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getDispatcherPauseOnAckStatePersistent_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get dispatcher pause on ack state persistent config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get dispatcher pause on ack state persistent config on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setDispatcherPauseOnAckStatePersistent_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set dispatcher pause on ack state persistent configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/entryFilters": { "delete": { "operationId": "removeEntryFilters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove entry filters for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getEntryFilters", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryFilters" } } }, "description": "Get entry filters for a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenants or Namespace doesn't exist" } }, "summary": "Get entry filters for a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setEntryFilters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/EntryFilters" } } }, "description": "Entry filters for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set entry filters for specified topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/examinemessage": { "get": { "operationId": "examineMessage", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Relative start position to examine message. It can be 'latest' or 'earliest'", "in": "query", "name": "initialPosition", "schema": { "default": "latest", "enum": [ "latest", "earliest" ], "type": "string" } }, { "description": "The position of messages (default 1)", "in": "query", "name": "messagePosition", "schema": { "default": 1, "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic, the message position does not exist" }, "405": { "description": "If given partitioned topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Examine a specific message on a topic by position relative to the earliest or the latest message.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/inactiveTopicPolicies": { "delete": { "operationId": "deleteInactiveTopicPolicies", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete inactive topic policies on a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getInactiveTopicPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InactiveTopicPolicies" } } }, "description": "Get inactive topic policies on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get inactive topic policies on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setInactiveTopicPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InactiveTopicPolicies" } } }, "description": "inactive topic policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set inactive topic policies on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/internal-info": { "get": { "operationId": "getManagedLedgerInfo", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedManagedLedgerInfo" } } }, "description": "Get the stored topic metadata." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stored topic metadata.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/internalStats": { "get": { "operationId": "getInternalStats", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "metadata", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistentTopicInternalStats" } } }, "description": "Get the internal stats for the topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the internal stats for the topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/lastMessageId": { "get": { "operationId": "getLastMessageId", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageIdAdv" } } }, "description": "Return the last commit message id of topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Return the last commit message id of topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/ledger/{ledgerId}/entry/{entryId}": { "get": { "operationId": "getMessageById", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "The ledger id", "in": "path", "name": "ledgerId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "The entry id", "in": "path", "name": "entryId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic, subscription or the message position does not exist" }, "405": { "description": "Skipping messages on a non-persistent topic is not allowed" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get message by its messageId.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/maxConsumers": { "delete": { "operationId": "removeMaxConsumers", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxConsumers config for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMaxConsumers", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxConsumers config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxConsumers config for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMaxConsumers", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max consumers of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxConsumers" } }, "summary": "Set maxConsumers config for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/maxConsumersPerSubscription": { "delete": { "operationId": "removeMaxConsumersPerSubscription_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove max consumers per subscription configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMaxConsumersPerSubscription_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get max consumers per subscription configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get max consumers per subscription configuration for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMaxConsumersPerSubscription_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set max consumers per subscription configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/maxMessageSize": { "delete": { "operationId": "removeMaxMessageSize", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxMessageSize config for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMaxMessageSize", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxMessageSize config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxMessageSize config for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMaxMessageSize", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max message size of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxConsumers" } }, "summary": "Set maxMessageSize config for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/maxProducers": { "delete": { "operationId": "removeMaxProducers", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxProducers config for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMaxProducers", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxProducers config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxProducers config for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMaxProducers", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max producers of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxProducers" } }, "summary": "Set maxProducers config for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/maxSubscriptionsPerTopic": { "delete": { "operationId": "removeMaxSubscriptionsPerTopic_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove maxSubscriptionsPerTopic config for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMaxSubscriptionsPerTopic_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get maxSubscriptionsPerTopic config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get maxSubscriptionsPerTopic config for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMaxSubscriptionsPerTopic_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "The max subscriptions of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of maxSubscriptionsPerTopic" } }, "summary": "Set maxSubscriptionsPerTopic config for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnConsumer": { "delete": { "operationId": "deleteMaxUnackedMessagesOnConsumer", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete max unacked messages per consumer config on a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMaxUnackedMessagesOnConsumer", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get max unacked messages per consumer config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get max unacked messages per consumer config on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMaxUnackedMessagesOnConsumer", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Max unacked messages on consumer policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set max unacked messages per consumer config on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/maxUnackedMessagesOnSubscription": { "delete": { "operationId": "deleteMaxUnackedMessagesOnSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete max unacked messages per subscription config on a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMaxUnackedMessagesOnSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get max unacked messages per subscription config on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get max unacked messages per subscription config on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMaxUnackedMessagesOnSubscription", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Max unacked messages on subscription policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set max unacked messages per subscription config on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/messageTTL": { "delete": { "operationId": "removeMessageTTL", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Not authenticate to perform the request or policy is read only" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid message TTL value" } }, "summary": "Remove message TTL in seconds for a topic", "tags": [ "persistent topic" ] }, "get": { "operationId": "getMessageTTL", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get message TTL in seconds for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get message TTL in seconds for a topic", "tags": [ "persistent topic" ] }, "post": { "operationId": "setMessageTTL", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "TTL in seconds for the specified topic", "in": "query", "name": "messageTTL", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Not authenticate to perform the request or policy is read only" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid message TTL value" } }, "summary": "Set message TTL in seconds for a topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/messageid/{timestamp}": { "get": { "operationId": "getMessageIdByTimestamp", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Specify the timestamp", "in": "path", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageIdAdv" } } }, "description": "Get message ID published at or just after this absolute timestamp (in ms)." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Topic is not non-partitioned and persistent" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get message ID published at or just after this absolute timestamp (in ms).", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/offload": { "get": { "operationId": "offloadStatus", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffloadProcessStatus" } } }, "description": "Offload a prefix of a topic to long term storage" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Offload a prefix of a topic to long term storage", "tags": [ "persistent topic" ] }, "put": { "operationId": "triggerOffload", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MessageIdImpl" } } } }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "400": { "description": "Message ID is null" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "409": { "description": "Offload already running" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Offload a prefix of a topic to long term storage", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/offloadPolicies": { "delete": { "operationId": "removeOffloadPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Delete offload policies on a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getOffloadPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OffloadPoliciesImpl" } } }, "description": "Get offload policies on a topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get offload policies on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setOffloadPolicies_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OffloadPoliciesImpl" } } }, "description": "Offload policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or cluster or namespace or topic doesn't exist" } }, "summary": "Set offload policies on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/partitioned-internalStats": { "get": { "operationId": "getPartitionedStatsInternal", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicInternalStats" } } }, "description": "Get the stats-internal for the partitioned topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stats-internal for the partitioned topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/partitioned-stats": { "get": { "operationId": "getPartitionedStats", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Get per partition stats", "in": "query", "name": "perPartition", "schema": { "default": true, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "If return precise backlog or imprecise backlog", "in": "query", "name": "getPreciseBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", "in": "query", "name": "subscriptionBacklogSize", "schema": { "default": true, "type": "boolean" } }, { "description": "If return the earliest time in backlog", "in": "query", "name": "getEarliestTimeInBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the publishers", "in": "query", "name": "excludePublishers", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the consumers", "in": "query", "name": "excludeConsumers", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicStatsImpl" } } }, "description": "Get the stats for the partitioned topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stats for the partitioned topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/partitions": { "delete": { "description": "It will also delete all the partitions of the topic if it exists.", "operationId": "deletePartitionedTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Stop all producer/consumer/replicator and delete topic forcefully", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Partitioned topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Delete a partitioned topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getPartitionedMetadata", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "Is check configuration required to automatically create topic", "in": "query", "name": "checkAllowAutoCreation", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicMetadata" } } }, "description": "Get partitioned topic metadata." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Partitioned topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Get partitioned topic metadata.", "tags": [ "persistent topic" ] }, "post": { "description": "It increments the partitions of an existing partitioned topic.", "operationId": "updatePartitionedTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateLocalTopicOnly", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "default": "0", "type": "integer" } } }, "description": "The number of partitions for the topic", "required": true }, "responses": { "204": { "description": "Update topic partition successful." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden/Unauthorized" }, "404": { "description": "Topic does not exist" }, "412": { "description": "Partitioned topic name is invalid" }, "422": { "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic and number of new partitions must be greater than existing number of partitions" }, "500": { "description": "Internal server error" } }, "summary": "Increment partitions of an existing partitioned topic.", "tags": [ "persistent topic" ] }, "put": { "description": "It needs to be called before creating a producer on a partitioned topic.", "operationId": "createPartitionedTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "createLocalTopicOnly", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "default": "0", "type": "integer" } }, "application/vnd.partitioned-topic-metadata+json": { "schema": { "$ref": "#/components/schemas/PartitionedTopicMetadata" } } }, "description": "The number of partitions for the topic, or the partitioned topic metadata (partitions and properties) when the request is sent with the 'application/vnd.partitioned-topic-metadata+json' content type", "required": true }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or namespace doesn't exist" }, "406": { "description": "The number of partitions should be more than 0 and less than or equal to maxNumPartitionsPerPartitionedTopic" }, "409": { "description": "Partitioned topic already exists" }, "412": { "description": "Failed Reason : Name is invalid or Namespace does not have any clusters configured" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Create a partitioned topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/permissions": { "get": { "description": "Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic. Returns a map structure: Map>.", "operationId": "getPermissionsOnTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "enum": [ "produce", "consume", "functions", "sources", "sinks", "packages" ], "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" } } }, "description": "Get permissions on a topic." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Get permissions on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/permissions/{role}": { "delete": { "description": "Revoke permissions to a 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).", "operationId": "revokePermissionsOnTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Client role to which grant permissions", "in": "path", "name": "role", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "412": { "description": "Permissions are not set at the topic level" }, "500": { "description": "Internal server error" } }, "summary": "Revoke permissions on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "grantPermissionsOnTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Client role to which grant permissions", "in": "path", "name": "role", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "enum": [ "produce", "functions", "consume" ], "type": "string" } } }, "description": "Actions to be granted (produce,functions,consume)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "tenant/namespace/topic doesn't exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" } }, "summary": "Grant a new permission to a role on a single topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/persistence": { "delete": { "operationId": "removePersistence", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove configuration of persistence policies for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getPersistence_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistencePolicies" } } }, "description": "Get configuration of persistence policies for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get configuration of persistence policies for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setPersistence_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PersistencePolicies" } } }, "description": "Bookkeeper persistence policies for specified topic" }, "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid persistence policies" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set configuration of persistence policies for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/policies": { "delete": { "operationId": "deleteTopicPolicies", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "500": { "description": "Internal server error" } }, "summary": "Delete policies for a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/properties": { "delete": { "operationId": "removeProperties", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "key", "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Partitioned topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Partitioned topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Remove the key in properties on the given topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getProperties_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Get topic properties." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic name is invalid" }, "500": { "description": "Internal server error" } }, "summary": "Get topic properties.", "tags": [ "persistent topic" ] }, "put": { "operationId": "updateProperties", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Key value pair properties for the topic metadata" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Update the properties on the given topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/publishRate": { "delete": { "operationId": "removePublishRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove message publish rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getPublishRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishRate" } } }, "description": "Get publish rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get publish rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setPublishRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/PublishRate" } } }, "description": "Dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set message publish rate configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/replication": { "delete": { "operationId": "removeReplicationClusters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove the replication clusters from a topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getReplicationClusters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the replication clusters for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get the replication clusters for a topic", "tags": [ "persistent topic" ] }, "post": { "operationId": "setReplicationClusters", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "List of replication clusters", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic is not global or invalid cluster ids" } }, "summary": "Set the replication clusters for a topic. When removing a cluster: with shared configuration store, topic data will be deleted from the removed cluster; with separate configuration store, only replication stops but topic data is preserved.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/replicatorDispatchRate": { "delete": { "operationId": "removeReplicatorDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove replicatorDispatchRate config for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getReplicatorDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get replicatorDispatchRate config for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get replicatorDispatchRate config for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setReplicatorDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Replicator dispatch rate of the topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Invalid value of replicatorDispatchRate" } }, "summary": "Set replicatorDispatchRate config for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/retention": { "delete": { "operationId": "removeRetention_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Retention Quota must exceed backlog quota" } }, "summary": "Remove retention configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getRetention_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } }, "description": "Get retention configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get retention configuration for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setRetention_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RetentionPolicies" } } }, "description": "Retention policies for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Retention Quota must exceed backlog quota" } }, "summary": "Set retention configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/schemaCompatibilityStrategy": { "delete": { "operationId": "removeSchemaCompatibilityStrategy", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "Strategy used to check the compatibility of new schema" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Operation not allowed on persistent topic" } }, "summary": "Remove schema compatibility strategy on a topic", "tags": [ "persistent topic" ] }, "get": { "operationId": "getSchemaCompatibilityStrategy_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the cluster", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "Get schema compatibility strategy on a topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Operation not allowed on persistent topic" } }, "summary": "Get schema compatibility strategy on a topic", "tags": [ "persistent topic" ] }, "put": { "operationId": "setSchemaCompatibilityStrategy_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "enum": [ "UNDEFINED", "ALWAYS_INCOMPATIBLE", "ALWAYS_COMPATIBLE", "BACKWARD", "FORWARD", "FULL", "BACKWARD_TRANSITIVE", "FORWARD_TRANSITIVE", "FULL_TRANSITIVE" ], "type": "string" } } }, "description": "Strategy used to check the compatibility of new schema" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Operation not allowed on persistent topic" } }, "summary": "Set schema compatibility strategy on a topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/schemaValidationEnforced": { "get": { "operationId": "getSchemaValidationEnforced", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "boolean" } } }, "description": "Get schema validation enforced flag for topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenants or Namespace doesn't exist" } }, "summary": "Get schema validation enforced flag for topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setSchemaValidationEnforced_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Tenant or Namespace doesn't exist" }, "412": { "description": "schemaValidationEnforced value is not valid" } }, "summary": "Set schema validation enforced flag on topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/shadowTopics": { "delete": { "operationId": "deleteShadowTopics", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Delete shadow topics for a topic", "tags": [ "persistent topic" ] }, "get": { "operationId": "getShadowTopics", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the shadow topic list for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get the shadow topic list for a topic", "tags": [ "persistent topic" ] }, "put": { "operationId": "setShadowTopics", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "List of shadow topics", "required": true }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set shadow topic list for a topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/stats": { "get": { "operationId": "getStats", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "If return precise backlog or imprecise backlog", "in": "query", "name": "getPreciseBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If return backlog size for each subscription, require locking on ledger so be careful not to use when there's heavy traffic.", "in": "query", "name": "subscriptionBacklogSize", "schema": { "default": true, "type": "boolean" } }, { "description": "If return time of the earliest message in backlog", "in": "query", "name": "getEarliestTimeInBacklog", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the publishers", "in": "query", "name": "excludePublishers", "schema": { "default": false, "type": "boolean" } }, { "description": "If exclude the consumers", "in": "query", "name": "excludeConsumers", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersistentTopicStats" } } }, "description": "Get the stats for the topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the stats for the topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscribeRate": { "delete": { "operationId": "removeSubscribeRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Subscribe rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove subscribe rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getSubscribeRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Get subscribe rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get subscribe rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setSubscribeRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SubscribeRate" } } }, "description": "Subscribe rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set subscribe rate configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}": { "delete": { "description": "The subscription cannot be deleted if delete is not forcefully and there are any active consumers attached to it. Force delete ignores connected consumers and deletes subscription by explicitly closing them.", "operationId": "deleteSubscription", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to be deleted", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Disconnect and close all consumers and delete subscription forcefully", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "412": { "description": "Subscription has active consumers" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Delete a subscription.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/analyzeBacklog": { "post": { "operationId": "analyzeSubscriptionBacklog", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResetCursorData" } } }, "description": "messageId to start the analysis" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Analyse a subscription, by scanning all the unprocessed messages", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages": { "post": { "operationId": "expireTopicMessages", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to expire messages on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResetCursorData" } } }, "description": "messageId to reset back to (ledgerId:entryId)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Expiring messages on a non-persistent topic is not allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Expire messages on a topic subscription.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/expireMessages/{expireTimeInSeconds}": { "post": { "operationId": "expireTopicMessages_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to expire messages on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Expires beyond the specified number of seconds", "in": "path", "name": "expireTimeInSeconds", "required": true, "schema": { "default": 0, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Expiring messages on a non-persistent topic is not allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Expire messages on a topic subscription.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/position/{messagePosition}": { "get": { "operationId": "peekNthMessage", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscribed message expired", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "The number of messages (default 1)", "in": "path", "name": "messagePosition", "required": true, "schema": { "default": 1, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "description": "Successfully retrieved the message. The response is a binary byte stream containing the message data. Clients need to parse this binary stream based on the message metadata provided in the response headers." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic, subscription or the message position does not exist" }, "405": { "description": "Skipping messages on a non-persistent topic is not allowed" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Peek nth message on a topic subscription.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/properties": { "get": { "operationId": "getSubscriptionProperties", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Return all the properties on the given subscription" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Return all the properties on the given subscription", "tags": [ "persistent topic" ] }, "put": { "operationId": "updateSubscriptionProperties", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to update", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "The new properties" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Replace all the properties on the given subscription", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/replicatedSubscriptionStatus": { "get": { "operationId": "getReplicatedSubscriptionStatus", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "boolean" }, "type": "object" } } }, "description": "Get replicated subscription status on a topic." }, "401": { "description": "Don't have permission to administrate resources" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" } }, "summary": "Get replicated subscription status on a topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setReplicatedSubscriptionStatus", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "description": "Whether to enable replicated subscription", "required": true }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Topic or subscription does not exist" }, "405": { "description": "Operation not allowed on this topic" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Enable or disable a replicated subscription on a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor": { "post": { "description": "It fences the cursor and disconnects all active consumers before resetting the cursor.", "operationId": "resetCursorOnPosition", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to reset position on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResetCursorData" } } }, "description": "messageId to reset back to (ledgerId:entryId)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Not supported for partitioned topics" }, "412": { "description": "Unable to find position for position specified" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Reset subscription to message position closest to given position.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/resetcursor/{timestamp}": { "post": { "description": "It fences the cursor and disconnects all active consumers before resetting the cursor.", "operationId": "resetCursor", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription to reset position on", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "the timestamp to reset back", "in": "path", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Method Not Allowed" }, "412": { "description": "Failed to reset cursor on subscription or Unable to find position for timestamp specified" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Reset subscription to message position closest to absolute timestamp (in ms).", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip/{numMessages}": { "post": { "operationId": "skipMessages", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "The number of messages to skip", "in": "path", "name": "numMessages", "required": true, "schema": { "default": 0, "format": "int32", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Skipping messages on a partitioned topic is not allowed" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Skipping messages on a topic subscription.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subName}/skip_all": { "post": { "description": "Completely clears the backlog on the subscription.", "operationId": "skipAllMessages", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription", "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Operation not allowed on non-persistent topic" }, "412": { "description": "Can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Skip all messages on a topic subscription.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscription/{subscriptionName}": { "put": { "description": "Creates a subscription on the topic at the specified message id", "operationId": "createSubscription", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Name of subscription to be created", "in": "path", "name": "subscriptionName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "Is replicated required to perform this operation", "in": "query", "name": "replicated", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "default": "latest", "enum": [ "latest", "earliest", "ledgerId:entryId" ], "type": "string" } } }, "description": "messageId where to create the subscription. It can be 'latest', 'earliest' or (ledgerId:entryId)" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "400": { "description": "Creating a subscription on a non-persistent topic is not supported" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic or subscription does not exist" }, "405": { "description": "Not supported for partitioned topics" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Create a subscription on the topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscriptionDispatchRate": { "delete": { "operationId": "removeSubscriptionDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove subscription message dispatch rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getSubscriptionDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get subscription message dispatch rate configuration for specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get subscription message dispatch rate configuration for specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setSubscriptionDispatchRate_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Subscription message dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set subscription message dispatch rate configuration for specified topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscriptionExpirationTime": { "delete": { "operationId": "removeSubscriptionExpirationTime_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid subscription expiration time value" } }, "summary": "Remove subscription expiration time for a topic", "tags": [ "persistent topic" ] }, "get": { "operationId": "getSubscriptionExpirationTime_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "int32", "type": "integer" } } }, "description": "Get subscription expiration time in minutes for a topic" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" } }, "summary": "Get subscription expiration time in minutes for a topic", "tags": [ "persistent topic" ] }, "post": { "operationId": "setSubscriptionExpirationTime_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription expiration time in minutes", "in": "query", "name": "subscriptionExpirationTime", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, enable the topic level policy and retry" }, "412": { "description": "Invalid subscription expiration time value" } }, "summary": "Set subscription expiration time in minutes for a topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscriptionTypesEnabled": { "delete": { "operationId": "removeSubscriptionTypesEnabled_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, to enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove subscription types enabled for specified topic.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getSubscriptionTypesEnabled_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "enum": [ "Exclusive", "Shared", "Failover", "Key_Shared" ], "type": "string" }, "type": "array" } } }, "description": "Get the enabled subscription types for the specified topic." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get the enabled subscription types for the specified topic.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setSubscriptionTypesEnabled_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "items": { "enum": [ "Exclusive", "Shared", "Failover", "Key_Shared" ], "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Enable sub types for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set the enabled subscription types for the specified topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/subscriptions": { "get": { "operationId": "getSubscriptions", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of persistent subscriptions for a given topic." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Get the list of persistent subscriptions for a given topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/terminate": { "post": { "operationId": "terminate", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageIdAdv" } } }, "description": "Operation terminated successfully. The response includes the 'lastMessageId', which is the identifier of the last message processed." }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Termination of a partitioned topic is not allowed" }, "406": { "description": "Need to provide a persistent topic name" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "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", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/terminate/partitions": { "post": { "operationId": "terminatePartitionedTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Termination of a non-partitioned topic is not allowed" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Terminate all partitioned 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", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/trim": { "post": { "operationId": "trimTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant or subscriber is not authorized to access this operation" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "405": { "description": "Operation is not allowed on the persistent topic" }, "412": { "description": "Topic name is not valid" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": " Trim a topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/truncate": { "delete": { "description": "The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.", "operationId": "truncateTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "500": { "description": "Internal server error" } }, "summary": "Truncate a topic.", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/unload": { "put": { "operationId": "unloadTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic does not exist" }, "409": { "description": "Concurrent modification" }, "412": { "description": "Topic name is not valid or can't find owner for topic" }, "500": { "description": "Internal server error" }, "503": { "description": "Failed to validate global cluster configuration" } }, "summary": "Unload a topic", "tags": [ "persistent topic" ] } }, "/admin/v2/persistent/{tenant}/{namespace}/{topic}/{subName}/dispatchRate": { "delete": { "operationId": "removeSubscriptionLevelDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove message dispatch rate configuration for specified subscription.", "tags": [ "persistent topic" ] }, "get": { "operationId": "getSubscriptionLevelDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "applied", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRate" } } }, "description": "Get message dispatch rate configuration for specified subscription." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Get message dispatch rate configuration for specified subscription.", "tags": [ "persistent topic" ] }, "post": { "operationId": "setSubscriptionLevelDispatchRate", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "subName", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker. For internal use.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "isGlobal", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DispatchRateImpl" } } }, "description": "Subscription message dispatch rate for the specified topic" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace or topic doesn't exist" }, "405": { "description": "Topic level policy is disabled, please enable the topic level policy and retry" }, "409": { "description": "Concurrent modification" } }, "summary": "Set message dispatch rate configuration for specified subscription.", "tags": [ "persistent topic" ] } }, "/admin/v2/resource-quotas": { "get": { "operationId": "getDefaultResourceQuota", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the default quota" }, "403": { "description": "Don't have admin permission" } }, "summary": "Get the default quota", "tags": [ "resource-quotas" ] }, "post": { "operationId": "setDefaultResourceQuota", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceQuota" } } }, "description": "Default resource quota" }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Set the default quota" }, "403": { "description": "Don't have admin permission" } }, "summary": "Set the default quota", "tags": [ "resource-quotas" ] } }, "/admin/v2/resource-quotas/{tenant}/{namespace}/{bundle}": { "delete": { "operationId": "removeNamespaceBundleResourceQuota", "parameters": [ { "description": "Tenant name", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Namespace name within the specified tenant", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Namespace bundle range", "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "409": { "description": "Concurrent modification" } }, "summary": "Remove resource quota for a namespace.", "tags": [ "resource-quotas" ] }, "get": { "operationId": "getNamespaceBundleResourceQuota", "parameters": [ { "description": "Tenant name", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Namespace name within the specified tenant", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Namespace bundle range", "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceQuota" } } }, "description": "Get resource quota of a namespace bundle." }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "Namespace does not exist" } }, "summary": "Get resource quota of a namespace bundle.", "tags": [ "resource-quotas" ] }, "post": { "operationId": "setNamespaceBundleResourceQuota", "parameters": [ { "description": "Tenant name", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Namespace name within the specified tenant", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Namespace bundle range", "in": "path", "name": "bundle", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceQuota" } } }, "description": "Resource quota for the specified namespace" }, "responses": { "204": { "description": "Operation successful" }, "307": { "description": "Current broker doesn't serve the namespace" }, "403": { "description": "Don't have admin permission" }, "409": { "description": "Concurrent modification" } }, "summary": "Set resource quota on a namespace.", "tags": [ "resource-quotas" ] } }, "/admin/v2/resourcegroups": { "get": { "operationId": "getResourceGroups", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Get the list of all the resourcegroups." }, "403": { "description": "Don't have admin permission" } }, "summary": "Get the list of all the resourcegroups.", "tags": [ "resourcegroups" ] } }, "/admin/v2/resourcegroups/{resourcegroup}": { "delete": { "operationId": "deleteResourceGroup", "parameters": [ { "in": "path", "name": "resourcegroup", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "ResourceGroup doesn't exist" }, "409": { "description": "ResourceGroup is in use" } }, "summary": "Delete a resourcegroup.", "tags": [ "resourcegroups" ] }, "get": { "operationId": "getResourceGroup", "parameters": [ { "in": "path", "name": "resourcegroup", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceGroup" } } }, "description": "Get the rate limiters specified for a resourcegroup." }, "403": { "description": "Don't have admin permission" }, "404": { "description": "ResourceGroup doesn't exist" } }, "summary": "Get the rate limiters specified for a resourcegroup.", "tags": [ "resourcegroups" ] }, "put": { "operationId": "createOrUpdateResourceGroup", "parameters": [ { "in": "path", "name": "resourcegroup", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceGroup" } } }, "description": "Rate limiters for the resourcegroup" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "Don't have admin permission" }, "404": { "description": "cluster doesn't exist" } }, "summary": "Creates a new resourcegroup with the specified rate limiters", "tags": [ "resourcegroups" ] } }, "/admin/v2/scalable/{tenant}/{namespace}": { "get": { "operationId": "getList_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Filter to topics whose properties contain every key=value pair. Each repetition of the parameter adds one filter (AND semantics).", "in": "query", "name": "property", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of scalable topics under a namespace." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Tenant or namespace doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get the list of scalable topics under a namespace.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}": { "delete": { "operationId": "deleteScalableTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Force deletion even if topic has active subscriptions", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Scalable topic deleted successfully" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Delete a scalable topic and all its segments.", "tags": [ "scalable topic" ] }, "get": { "operationId": "getScalableTopicMetadata", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScalableTopicMetadata" } } }, "description": "Get scalable topic metadata." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get scalable topic metadata.", "tags": [ "scalable topic" ] }, "put": { "operationId": "createScalableTopic", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Number of initial segments", "in": "query", "name": "numInitialSegments", "schema": { "default": 1, "format": "int32", "type": "integer" } } ], "requestBody": { "content": { "*/*": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Key value pair properties for the topic metadata" }, "responses": { "204": { "description": "Scalable topic created successfully" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "409": { "description": "Scalable topic already exists" }, "412": { "description": "Invalid configuration" }, "500": { "description": "Internal server error" } }, "summary": "Create a new scalable topic.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/autoScalePolicy": { "delete": { "operationId": "removeAutoScalePolicy", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Override removed successfully" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Remove the per-topic auto split/merge policy override.", "tags": [ "scalable topic" ] }, "get": { "operationId": "getAutoScalePolicy", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoScalePolicyOverride" } } }, "description": "The per-topic auto split/merge policy override." }, "204": { "description": "No override is set on this topic" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get the per-topic auto split/merge policy override.", "tags": [ "scalable topic" ] }, "post": { "operationId": "setAutoScalePolicy", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AutoScalePolicyOverride" } } }, "description": "Auto split/merge policy override", "required": true }, "responses": { "204": { "description": "Override set successfully" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic doesn't exist" }, "412": { "description": "The resolved auto split/merge policy violates an invariant" }, "500": { "description": "Internal server error" } }, "summary": "Set the per-topic auto split/merge policy override.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/merge/{segmentId1}/{segmentId2}": { "post": { "operationId": "mergeSegments", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "First segment ID to merge", "in": "path", "name": "segmentId1", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Second segment ID to merge", "in": "path", "name": "segmentId2", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "204": { "description": "Segments merged successfully" }, "404": { "description": "Scalable topic or segment doesn't exist" }, "412": { "description": "Segments are not active or not adjacent" }, "500": { "description": "Internal server error" } }, "summary": "Merge two adjacent segments into one.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/migrate": { "post": { "operationId": "migrateToScalable", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Migrate even if legacy v4 clients are still connected to the topic", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Topic migrated successfully" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have produce permission on the topic" }, "404": { "description": "Topic doesn't exist" }, "409": { "description": "Already a scalable topic, or legacy v4 clients are still connected and force was not set" }, "500": { "description": "Internal server error" } }, "summary": "Migrate an existing regular (partitioned or non-partitioned) topic to a scalable topic.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/split/{segmentId}": { "post": { "operationId": "splitSegment", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment ID to split", "in": "path", "name": "segmentId", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "204": { "description": "Segment split successfully" }, "404": { "description": "Scalable topic or segment doesn't exist" }, "412": { "description": "Segment is not active or cannot be split" }, "500": { "description": "Internal server error" } }, "summary": "Split a segment into two halves.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/stats": { "get": { "operationId": "getStats_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScalableTopicStats" } } }, "description": "Get aggregated stats for a scalable topic." }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Get aggregated stats for a scalable topic.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/subscriptions/{subscription}": { "delete": { "operationId": "deleteSubscription_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Subscription deleted successfully" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic or subscription doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Delete a subscription from a scalable topic.", "tags": [ "scalable topic" ] }, "put": { "operationId": "createSubscription_2", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "description": "Subscription type: STREAM (controller-managed, ordered) or QUEUE (direct per-segment attach, no controller coordination)", "in": "query", "name": "type", "schema": { "default": "STREAM", "enum": [ "STREAM", "QUEUE" ], "type": "string" } } ], "responses": { "204": { "description": "Subscription created successfully" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Create a subscription on a scalable topic.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/subscriptions/{subscription}/seek": { "post": { "operationId": "seekSubscription", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "description": "Wall-clock millis since the unix epoch", "in": "query", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "204": { "description": "Cursor reset successfully on all segments" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic or subscription doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Reset a subscription's cursor on every segment to the given wall-clock timestamp. The controller uses each segment's recorded sealed-time window to dispatch the cheapest per-segment op.", "tags": [ "scalable topic" ] } }, "/admin/v2/scalable/{tenant}/{namespace}/{topic}/subscriptions/{subscription}/skip-all": { "post": { "operationId": "clearBacklog", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Backlog cleared successfully on all segments" }, "401": { "description": "Don't have permission to administrate resources on this tenant" }, "403": { "description": "Don't have admin permission on the namespace" }, "404": { "description": "Scalable topic or subscription doesn't exist" }, "500": { "description": "Internal server error" } }, "summary": "Skip every undelivered message on the subscription, across every segment in the DAG (advance each per-segment cursor to the end).", "tags": [ "scalable topic" ] } }, "/admin/v2/schemas/{tenant}/{namespace}/{topic}/compatibility": { "post": { "operationId": "testCompatibility", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "example": { "properties": { "key1": "value1" }, "schema": "", "type": "STRING" }, "schema": { "$ref": "#/components/schemas/PostSchemaPayload" } } }, "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IsCompatibilityResponse" } } }, "description": "test the schema compatibility" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist" }, "412": { "description": "Failed to find the ownership for the topic" }, "500": { "description": "Internal Server Error" } }, "summary": "test the schema compatibility", "tags": [ "schemas" ] } }, "/admin/v2/schemas/{tenant}/{namespace}/{topic}/metadata": { "get": { "operationId": "getSchemaMetadata", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllVersionsSchemaResponse" } } }, "description": "Get the schema metadata of a topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" }, "412": { "description": "Failed to find the ownership for the topic" }, "500": { "description": "Internal Server Error" } }, "summary": "Get the schema metadata of a topic", "tags": [ "schemas" ] } }, "/admin/v2/schemas/{tenant}/{namespace}/{topic}/schema": { "delete": { "operationId": "deleteSchema", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSchemaResponse" } } }, "description": "Delete all versions schema of a topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist" }, "412": { "description": "Failed to find the ownership for the topic" }, "500": { "description": "Internal Server Error" } }, "summary": "Delete all versions schema of a topic", "tags": [ "schemas" ] }, "get": { "operationId": "getSchema", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSchemaResponse" } } }, "description": "Get the schema of a topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" }, "412": { "description": "Failed to find the ownership for the topic" }, "500": { "description": "Internal Server Error" } }, "summary": "Get the schema of a topic", "tags": [ "schemas" ] }, "post": { "operationId": "postSchema", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "example": { "properties": { "key1": "value1" }, "schema": "", "type": "STRING" }, "schema": { "$ref": "#/components/schemas/PostSchemaPayload" } } }, "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostSchemaResponse" } } }, "description": "Update the schema of a topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist" }, "409": { "description": "Incompatible schema" }, "412": { "description": "Failed to find the ownership for the topic" }, "422": { "description": "Invalid schema data" }, "500": { "description": "Internal Server Error" } }, "summary": "Update the schema of a topic", "tags": [ "schemas" ] } }, "/admin/v2/schemas/{tenant}/{namespace}/{topic}/schema/{version}": { "get": { "operationId": "getSchema_1", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "version", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSchemaResponse" } } }, "description": "Get the schema of a topic at a given version" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" }, "412": { "description": "Failed to find the ownership for the topic" }, "500": { "description": "Internal Server Error" } }, "summary": "Get the schema of a topic at a given version", "tags": [ "schemas" ] } }, "/admin/v2/schemas/{tenant}/{namespace}/{topic}/schemas": { "get": { "operationId": "getAllSchemas", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllVersionsSchemaResponse" } } }, "description": "Get the all schemas of a topic" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist; or Schema is not found for this topic" }, "412": { "description": "Failed to find the ownership for the topic" }, "500": { "description": "Internal Server Error" } }, "summary": "Get the all schemas of a topic", "tags": [ "schemas" ] } }, "/admin/v2/schemas/{tenant}/{namespace}/{topic}/version": { "post": { "operationId": "getVersionBySchema", "parameters": [ { "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "example": { "properties": { "key1": "value1" }, "schema": "", "type": "STRING" }, "schema": { "$ref": "#/components/schemas/PostSchemaPayload" } } }, "description": "A JSON value presenting a schema payload. An example of the expected schema can be found down here." }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LongSchemaVersion" } } }, "description": "get the version of the schema" }, "307": { "description": "Current broker doesn't serve the namespace of this topic" }, "401": { "description": "Client is not authorized or Don't have admin permission" }, "403": { "description": "Client is not authenticated" }, "404": { "description": "Tenant or Namespace or Topic doesn't exist" }, "412": { "description": "Failed to find the ownership for the topic" }, "422": { "description": "Invalid schema data" }, "500": { "description": "Internal Server Error" } }, "summary": "get the version of the schema", "tags": [ "schemas" ] } }, "/admin/v2/segments/{tenant}/{namespace}/{topic}/{descriptor}": { "delete": { "operationId": "deleteSegment", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } }, { "description": "Force deletion", "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Segment topic deleted successfully" }, "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "500": { "description": "Internal server error" } }, "summary": "Delete a segment topic. Super-user only.", "tags": [ "segments" ] }, "put": { "operationId": "createSegment", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "*/*": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Subscriptions to create on the new segment" }, "responses": { "204": { "description": "Segment topic created successfully" }, "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "500": { "description": "Internal server error" } }, "summary": "Create a segment topic on the owning broker. Super-user only.", "tags": [ "segments" ] } }, "/admin/v2/segments/{tenant}/{namespace}/{topic}/{descriptor}/subscription/{subscription}": { "delete": { "operationId": "deleteSubscription_3", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Subscription cursor deleted (or never existed)" }, "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "500": { "description": "Internal server error" } }, "summary": "Delete a subscription cursor on the segment topic. Super-user only.", "tags": [ "segments" ] }, "put": { "operationId": "createSubscription_3", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Subscription cursor created (or already existed)" }, "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "500": { "description": "Internal server error" } }, "summary": "Create a subscription cursor on the segment topic at the earliest position. Super-user only.", "tags": [ "segments" ] } }, "/admin/v2/segments/{tenant}/{namespace}/{topic}/{descriptor}/subscription/{subscription}/backlog": { "get": { "operationId": "getSubscriptionBacklog", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "404": { "description": "Segment topic or subscription not found" }, "500": { "description": "Internal server error" } }, "summary": "Number of unconsumed entries in the segment topic for the given subscription. Super-user only.", "tags": [ "segments" ] } }, "/admin/v2/segments/{tenant}/{namespace}/{topic}/{descriptor}/subscription/{subscription}/seek": { "post": { "operationId": "seekSubscription_1", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "description": "Wall-clock millis since the unix epoch", "in": "query", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Cursor reset successfully" }, "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "404": { "description": "Segment topic or subscription not found" }, "500": { "description": "Internal server error" } }, "summary": "Reset the segment topic's subscription cursor to the given timestamp. Super-user only.", "tags": [ "segments" ] } }, "/admin/v2/segments/{tenant}/{namespace}/{topic}/{descriptor}/subscription/{subscription}/skip-all": { "post": { "operationId": "clearSubscriptionBacklog", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Subscription name", "in": "path", "name": "subscription", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Backlog cleared successfully" }, "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "404": { "description": "Segment topic or subscription not found" }, "500": { "description": "Internal server error" } }, "summary": "Skip every undelivered message on the segment topic's subscription \u2014 advance the cursor to the end. Super-user only.", "tags": [ "segments" ] } }, "/admin/v2/segments/{tenant}/{namespace}/{topic}/{descriptor}/terminate": { "post": { "operationId": "terminateSegment", "parameters": [ { "description": "Specify the tenant", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "description": "Specify the namespace", "in": "path", "name": "namespace", "required": true, "schema": { "type": "string" } }, { "description": "Specify the parent topic name", "in": "path", "name": "topic", "required": true, "schema": { "type": "string" } }, { "description": "Segment descriptor (e.g. 0000-7fff-1)", "in": "path", "name": "descriptor", "required": true, "schema": { "type": "string" } }, { "description": "Whether leader broker redirected this call to this broker.", "in": "query", "name": "authoritative", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Segment topic terminated successfully" }, "401": { "description": "This operation requires super-user access" }, "403": { "description": "This operation requires super-user access" }, "404": { "description": "Segment topic not found" }, "500": { "description": "Internal server error" } }, "summary": "Terminate a segment topic so no more messages can be published. Super-user only.", "tags": [ "segments" ] } }, "/admin/v2/tenants": { "get": { "operationId": "getTenants", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Get the list of existing tenants." }, "403": { "description": "The requester doesn't have admin permissions" }, "404": { "description": "Tenant doesn't exist" } }, "summary": "Get the list of existing tenants.", "tags": [ "tenants" ] } }, "/admin/v2/tenants/{tenant}": { "delete": { "operationId": "deleteTenant", "parameters": [ { "description": "The tenant name", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Operation successful" }, "403": { "description": "The requester doesn't have admin permissions" }, "404": { "description": "Tenant does not exist" }, "405": { "description": "Broker doesn't allow forced deletion of tenants" }, "409": { "description": "The tenant still has active namespaces" } }, "summary": "Delete a tenant and all namespaces and topics under it.", "tags": [ "tenants" ] }, "get": { "operationId": "getTenantAdmin", "parameters": [ { "description": "The tenant name", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantInfo" } } }, "description": "Get the admin configuration for a given tenant." }, "403": { "description": "The requester doesn't have admin permissions" }, "404": { "description": "Tenant does not exist" } }, "summary": "Get the admin configuration for a given tenant.", "tags": [ "tenants" ] }, "post": { "description": "This operation requires Pulsar super-user privileges.", "operationId": "updateTenant", "parameters": [ { "description": "The tenant name", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantInfo" } } }, "description": "TenantInfo" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "The requester doesn't have admin permissions" }, "404": { "description": "Tenant does not exist" }, "409": { "description": "Tenant already exists" }, "412": { "description": "Clusters do not exist" } }, "summary": "Update the admins for a tenant.", "tags": [ "tenants" ] }, "put": { "description": "This operation requires Pulsar super-user privileges.", "operationId": "createTenant", "parameters": [ { "description": "The tenant name", "in": "path", "name": "tenant", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantInfo" } } }, "description": "TenantInfo" }, "responses": { "204": { "description": "Operation successful" }, "403": { "description": "The requester doesn't have admin permissions" }, "409": { "description": "Tenant already exists" }, "412": { "description": "Clusters do not exist" } }, "summary": "Create a new tenant.", "tags": [ "tenants" ] } }, "/admin/v2/worker-stats/functionsmetrics": { "get": { "description": "The request should be executed by a Monitoring agent on each worker to fetch the metrics", "operationId": "getStats_3", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WorkerFunctionInstanceStats" }, "type": "array" } } }, "description": "Get metrics for all functions owned by worker" }, "401": { "description": "Don't have admin permission" }, "503": { "description": "Worker service is not running" } }, "summary": "Get metrics for all functions owned by worker", "tags": [ "worker-stats" ] } }, "/admin/v2/worker-stats/metrics": { "get": { "description": "The request should be executed by a Monitoring agent on each worker to fetch the worker-metrics", "operationId": "getMetrics_1", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Metrics" }, "type": "array" } } }, "description": "Gets the metrics for Monitoring" }, "401": { "description": "Don't have admin permission" }, "503": { "description": "Worker service is not running" } }, "summary": "Gets the metrics for Monitoring", "tags": [ "worker-stats" ] } }, "/admin/v2/worker/assignments": { "get": { "description": "Returns a map structure: Map>.", "operationId": "getAssignments", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "type": "object" } } }, "description": "Fetches information about which Pulsar Functions are assigned to which Pulsar clusters" }, "403": { "description": "The requester doesn't have admin permissions" }, "503": { "description": "Worker service is not running" } }, "summary": "Fetches information about which Pulsar Functions are assigned to which Pulsar clusters", "tags": [ "worker" ] } }, "/admin/v2/worker/cluster": { "get": { "operationId": "getCluster_1", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WorkerInfo" }, "type": "array" } } }, "description": "Fetches information about the Pulsar cluster running Pulsar Functions" }, "403": { "description": "The requester doesn't have admin permissions" }, "503": { "description": "Worker service is not running" } }, "summary": "Fetches information about the Pulsar cluster running Pulsar Functions", "tags": [ "worker" ] } }, "/admin/v2/worker/cluster/leader": { "get": { "operationId": "getClusterLeader", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkerInfo" } } }, "description": "Fetches info about the leader node of the Pulsar cluster running Pulsar Functions" }, "403": { "description": "The requester doesn't have admin permissions" }, "503": { "description": "Worker service is not running" } }, "summary": "Fetches info about the leader node of the Pulsar cluster running Pulsar Functions", "tags": [ "worker" ] } }, "/admin/v2/worker/cluster/leader/ready": { "get": { "operationId": "isLeaderReady", "responses": { "200": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "description": "Checks if this node is the leader and is ready to service requests" }, "503": { "description": "Worker service is not running" } }, "summary": "Checks if this node is the leader and is ready to service requests", "tags": [ "worker" ] } }, "/admin/v2/worker/connectors": { "get": { "operationId": "getConnectorsList", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ConnectorDefinition" }, "type": "array" } } }, "description": "Fetches a list of supported Pulsar IO connectors currently running in cluster mode" }, "400": { "description": "Invalid request" }, "403": { "description": "The requester doesn't have admin permissions" }, "408": { "description": "Request timeout" } }, "summary": "Fetches a list of supported Pulsar IO connectors currently running in cluster mode", "tags": [ "worker" ] } }, "/admin/v2/worker/drain": { "get": { "operationId": "getDrainStatus", "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LongRunningProcessStatus" } } }, "description": "Get the status of any ongoing drain operation at this worker" }, "403": { "description": "The requester doesn't have admin permissions" }, "503": { "description": "Worker service is not ready" } }, "summary": "Get the status of any ongoing drain operation at this worker", "tags": [ "worker" ] }, "put": { "operationId": "drain", "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid request" }, "403": { "description": "The requester doesn't have admin permissions" }, "408": { "description": "Request timeout" }, "409": { "description": "Drain already in progress" }, "503": { "description": "Worker service is not ready" } }, "summary": "Drains this worker, i.e., moves its work-assignments to other workers", "tags": [ "worker" ] } }, "/admin/v2/worker/leader/drain": { "get": { "operationId": "getDrainStatusFromLeader", "parameters": [ { "in": "query", "name": "workerId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LongRunningProcessStatus" } } }, "description": "Get the status of any ongoing drain operation at the specified worker" }, "403": { "description": "The requester doesn't have admin permissions" }, "503": { "description": "Worker service is not ready" } }, "summary": "Get the status of any ongoing drain operation at the specified worker", "tags": [ "worker" ] }, "put": { "operationId": "drainAtLeader", "parameters": [ { "in": "query", "name": "workerId", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid request" }, "403": { "description": "The requester doesn't have admin permissions" }, "408": { "description": "Request timeout" }, "409": { "description": "Drain already in progress" }, "503": { "description": "Worker service is not ready" } }, "summary": "Drains the specified worker, i.e., moves its work-assignments to other workers", "tags": [ "worker" ] } }, "/admin/v2/worker/rebalance": { "put": { "operationId": "rebalance", "responses": { "204": { "description": "Operation successful" }, "400": { "description": "Invalid request" }, "403": { "description": "The requester doesn't have admin permissions" }, "408": { "description": "Request timeout" } }, "summary": "Triggers a rebalance of functions to workers", "tags": [ "worker" ] } } }, "servers": [ { "url": "http://localhost:8080" } ], "tags": [ { "description": "Configure bookies rack placement", "name": "bookies" }, { "description": "Stats for broker", "name": "broker-stats" }, { "description": "Brokers admin apis", "name": "brokers" }, { "description": "Cluster admin apis", "name": "clusters" }, { "description": "Metadata store migration admin APIs", "name": "metadata-migration" }, { "description": "Namespaces admin apis", "name": "namespaces" }, { "description": "Persistent topic admin apis", "name": "persistent topic" }, { "description": "Non-Persistent topic admin apis", "name": "non-persistent topic" }, { "description": "ResourceGroups admin apis", "name": "resourcegroups" }, { "description": "Quota admin APIs", "name": "resource-quotas" }, { "description": "Scalable topic admin APIs", "name": "scalable topic" }, { "description": "Schemas related admin APIs", "name": "schemas" }, { "description": "Segment topic admin APIs", "name": "segments" }, { "description": "Tenant admin apis", "name": "tenants" }, { "name": "worker" }, { "name": "worker-stats" } ] }