Files
sdk/docs/MonitoringApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

7.4 KiB

MonitoringApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
pubsubGetConnz GET /v1/pubsub/connz Connection details
pubsubGetGatewayz GET /v1/pubsub/gatewayz Gateway status
pubsubGetJsz GET /v1/pubsub/jsz JetStream info
pubsubGetLeafz GET /v1/pubsub/leafz Leaf node info
pubsubGetRoutez GET /v1/pubsub/routez Cluster routes
pubsubGetSubsz GET /v1/pubsub/subsz Subscription info
pubsubGetVarz GET /v1/pubsub/varz Server statistics

pubsubGetConnz

PubsubGetConnz200Response pubsubGetConnz(sort, limit)

Connection details

Active client connection information.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = MonitoringApi()
val sort : kotlin.String = sort_example // kotlin.String | Sort connections by field
val limit : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : PubsubGetConnz200Response = apiInstance.pubsubGetConnz(sort, limit)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MonitoringApi#pubsubGetConnz")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MonitoringApi#pubsubGetConnz")
    e.printStackTrace()
}

Parameters

| sort | kotlin.String| Sort connections by field | [optional] [enum: cid, start, subs, pending, msgs_to, msgs_from, bytes_to, bytes_from, last, idle, uptime, stop, reason] |

Name Type Description Notes
limit kotlin.Int [optional] [default to 1024]

Return type

PubsubGetConnz200Response

Authorization

No authorization required

HTTP request headers

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

pubsubGetGatewayz

kotlin.Any pubsubGetGatewayz()

Gateway status

Super-cluster gateway connection status.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = MonitoringApi()
try {
    val result : kotlin.Any = apiInstance.pubsubGetGatewayz()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MonitoringApi#pubsubGetGatewayz")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MonitoringApi#pubsubGetGatewayz")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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

pubsubGetJsz

PubsubJetStreamInfo pubsubGetJsz()

JetStream info

JetStream account and usage information.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = MonitoringApi()
try {
    val result : PubsubJetStreamInfo = apiInstance.pubsubGetJsz()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MonitoringApi#pubsubGetJsz")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MonitoringApi#pubsubGetJsz")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

PubsubJetStreamInfo

Authorization

No authorization required

HTTP request headers

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

pubsubGetLeafz

kotlin.Any pubsubGetLeafz()

Leaf node info

Leaf node connection details.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = MonitoringApi()
try {
    val result : kotlin.Any = apiInstance.pubsubGetLeafz()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MonitoringApi#pubsubGetLeafz")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MonitoringApi#pubsubGetLeafz")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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

pubsubGetRoutez

kotlin.Any pubsubGetRoutez()

Cluster routes

Cluster route connection information.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = MonitoringApi()
try {
    val result : kotlin.Any = apiInstance.pubsubGetRoutez()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MonitoringApi#pubsubGetRoutez")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MonitoringApi#pubsubGetRoutez")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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

pubsubGetSubsz

kotlin.Any pubsubGetSubsz()

Subscription info

Subscription routing tree information.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = MonitoringApi()
try {
    val result : kotlin.Any = apiInstance.pubsubGetSubsz()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MonitoringApi#pubsubGetSubsz")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MonitoringApi#pubsubGetSubsz")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.Any

Authorization

No authorization required

HTTP request headers

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

pubsubGetVarz

PubsubServerVarz pubsubGetVarz()

Server statistics

General server information including uptime, connections, message rates.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = MonitoringApi()
try {
    val result : PubsubServerVarz = apiInstance.pubsubGetVarz()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MonitoringApi#pubsubGetVarz")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MonitoringApi#pubsubGetVarz")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

PubsubServerVarz

Authorization

No authorization required

HTTP request headers

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