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

rpc GetStatus (tetrateio.api.tsb.v2.GetStatusRequest) returns (tetrateio.api.tsb.v2.ResourceStatus)

Given a resource fully-qualified name of a resource returns its current status.

SearchStatus

rpc SearchStatus (tetrateio.api.tsb.v2.SearchStatusRequest) returns (tetrateio.api.tsb.v2.SearchStatusResponse)

Search the status of resources related to the specified search criteria. It will descend in the hierarchy starting with the resource identified by the given FQN. This method is available for organizations, tenant or workspace resources. In the case of configuration sharing between multiple workspaces (such as common t1 and t2 scenarios), it’s recommended to use the tenant FQN instead of the workspace FQN. This ensures that the search is not limited to a specific workspace and considers configurations from other workspaces.

GetStatusRequest

Request to retrieve the status of a resource.

Field	Description	Validation 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.

Field	Description	Validation Rule
fqn	string OUTPUT_ONLY The fqn 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.	–
clusters	List of string OUTPUT_ONLY The names of the clusters to which the resource is scoped to based on the parents' namespace selector. Independently from the resource status, clusters field is returned based on the resource's configuration.	–

SearchStatusRequest

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

Field	Description	Validation 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.

Field	Description	Validation Rule
statuses	List of tetrateio.api.tsb.v2.ResourceStatusWithDetails Collections of status of resources related to the specified search criteria.	–