Subtenant Topics

Runtime information about a tenant's topic

Retrieve all topic infos

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

keys
string <enumeration>

Retrieve only the keys for the list

Value: "true"
count
string <enumeration>

Retrieve only the number of elements in the list

Value: "true"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/tenants/{tenant-name}/volga/topics
Response samples
- name: system:container-logs:alpine.my-srv-1.alpine
  archived:
    original-name: system:prev-container-logs:alpine.my-srv-1.alpine
    archive-time: 2022-09-01T22:20:24Z
    archive-days: 5
  tenant: telco
  labels:
    system/controller: "true"
  format: json
  max-size: 9.54 MiB
  max-days: 14
  creation-time: 2022-09-01T08:40:48.484Z
  requested-replication-factor: 3
  current-replication-factor: 1
  persistence: disk
  encryption: full
  transit-key: mykey
  assigned-hosts:
    - h01
  unsynced-hosts: []
  leader-host: h01
  worker-hosts: []
  size: 53.36 KiB
  entries: 41
  oldest-entry: 2022-09-01T22:19:23Z
  last-entry: 2022-09-01T22:20:23Z
  seqno: 41
  chunkno: 1
  dropped-chunks: 0
  producers:
    - name: notifications
      site: control-tower
      host: h01
  consumers:
    - name: myconsumer
      mode: exclusive
      last-delivered-seqno: 41
      last-acked-seqno: 30
      buffered-messages: 0
      blocking-producer: false
      dropped-messages: 0
      clients:
        - site: control-tower
          host: h01
          more-n: 64
  

Retrieve a topic info

SecurityaccessToken
Request
path Parameters
tenant-name
required
string <name> ^[a-z0-9]([a-z0-9\-]*[a-z0-9])?$

name of tenant

topic-info-name
required
string <topic-name> ^[0-9A-Za-z+_=:@.-]+$

Name of the topic

query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/tenants/{tenant-name}/volga/topics/{topic-info-name}
Response samples
name: system:container-logs:alpine.my-srv-1.alpine
archived:
  original-name: system:prev-container-logs:alpine.my-srv-1.alpine
  archive-time: 2022-09-01T22:20:24Z
  archive-days: 5
tenant: telco
labels:
  system/controller: "true"
format: json
max-size: 9.54 MiB
max-days: 14
creation-time: 2022-09-01T08:40:48.484Z
requested-replication-factor: 3
current-replication-factor: 1
persistence: disk
encryption: full
transit-key: mykey
assigned-hosts:
  - h01
unsynced-hosts: []
leader-host: h01
worker-hosts: []
size: 53.36 KiB
entries: 41
oldest-entry: 2022-09-01T22:19:23Z
last-entry: 2022-09-01T22:20:23Z
seqno: 41
chunkno: 1
dropped-chunks: 0
producers:
  - name: notifications
    site: control-tower
    host: h01
consumers:
  - name: myconsumer
    mode: exclusive
    last-delivered-seqno: 41
    last-acked-seqno: 30
    buffered-messages: 0
    blocking-producer: false
    dropped-messages: 0
    clients:
      - site: control-tower
        host: h01
        more-n: 64