Skip to main content
logoTetrate Service BridgeVersion: next

Status Service

Service to retrieve the status for TSB resources

Status​

The Status services exposes methods to retrieve the status for any resource managed by TSB.

GetStatus​

SearchStatus​

GetStatusRequest​

Request to retrieve the status of a resource.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the resource to retrieve the status.

string = {
  min_len: 1
}

ResourceStatusWithDetails​

Contains the ResourceStatus with metadata about the resource.

FieldDescriptionValidation Rule

fqn

string
OUTPUT_ONLY
The status of the resource.

–

apiVersion

string
OUTPUT_ONLY
API version of the resource.

–

name

string
OUTPUT_ONLY
Resource name.

–

status

tetrateio.api.tsb.v2.ResourceStatus
OUTPUT_ONLY
The status of the resource.

–

SearchStatusRequest​

Request to search the status of a resources related to specified search criteria.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the resource in which search will start.

string = {
  min_len: 1
}

fqdn

string
REQUIRED
Fully-qualified domain name to search in the mesh that exposes a service. Example: "test.tetrate.io"

string = {
  min_len: 1
}

SearchStatusResponse​

Response of the search query for the status of resources related to specified search criteria.

FieldDescriptionValidation Rule

statuses

List of tetrateio.api.tsb.v2.ResourceStatusWithDetails
Collections of status of resources related to the specified search criteria.

–