Skip to content

Files

Latest commit

 Cannot retrieve latest commit at this time.

History

History
executable file
·
246 lines (143 loc) · 7.02 KB

BrokersApi.md

File metadata and controls

executable file
·
246 lines (143 loc) · 7.02 KB

\BrokersApi

All URIs are relative to http://localhost/admin/v2

Method HTTP request Description
GetActiveBrokers Get /brokers/{cluster} Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.
GetAllDynamicConfigurations Get /brokers/configuration/values Get value of all dynamic configurations' value overridden on local config
GetDynamicConfigurationName Get /brokers/configuration Get all updatable dynamic configurations's name
GetInternalConfigurationData Get /brokers/internal-configuration Get the internal configuration data
GetOwnedNamespaes Get /brokers/{clusterName}/{broker-webserviceurl}/ownedNamespaces Get the list of namespaces served by the specific broker
GetRuntimeConfiguration Get /brokers/configuration/runtime Get all runtime configurations. This operation requires Pulsar super-user privileges.
Healthcheck Get /brokers/health Run a healthcheck against the broker
UpdateDynamicConfiguration Post /brokers/configuration/{configName}/{configValue} Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.

GetActiveBrokers

[]string GetActiveBrokers(ctx, cluster) Get the list of active brokers (web service addresses) in the cluster.If authorization is not enabled, any cluster name is valid.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cluster string

Return type

[]string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllDynamicConfigurations

map[string]map[string]interface{} GetAllDynamicConfigurations(ctx, ) Get value of all dynamic configurations' value overridden on local config

Required Parameters

This endpoint does not need any parameter.

Return type

map[string]map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDynamicConfigurationName

[]map[string]interface{} GetDynamicConfigurationName(ctx, ) Get all updatable dynamic configurations's name

Required Parameters

This endpoint does not need any parameter.

Return type

[]map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInternalConfigurationData

InternalConfigurationData GetInternalConfigurationData(ctx, ) Get the internal configuration data

Required Parameters

This endpoint does not need any parameter.

Return type

InternalConfigurationData

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOwnedNamespaes

map[string]NamespaceOwnershipStatus GetOwnedNamespaes(ctx, clusterName, brokerWebserviceurl) Get the list of namespaces served by the specific broker

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterName string
brokerWebserviceurl string

Return type

map[string]NamespaceOwnershipStatus

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRuntimeConfiguration

map[string]map[string]interface{} GetRuntimeConfiguration(ctx, ) Get all runtime configurations. This operation requires Pulsar super-user privileges.

Required Parameters

This endpoint does not need any parameter.

Return type

map[string]map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Healthcheck

Healthcheck(ctx, ) Run a healthcheck against the broker

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateDynamicConfiguration

UpdateDynamicConfiguration(ctx, configName, configValue) Update dynamic serviceconfiguration into zk only. This operation requires Pulsar super-user privileges.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
configName string
configValue string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]