Skip to main content
logoTetrate Service BridgeVersion: next

Traffic Service

Service to manage traffic settings.

Traffic

The Traffic service provides methods to manage traffic settings in TSB.

It provides methods to create and manage traffic groups within a workspace, allowing to create fine-grained groupings to configure a subset of the workspace namespaces. Access policies can be assigned at group level, providing a fine-grained access control to the traffic configuration features.

The Traffic service also provides methods to configure the different traffic settings that are allowed within each group.

CreateGroup

GetGroup

UpdateGroup

ListGroups

DeleteGroup

CreateSettings

GetSettings

UpdateSettings

ListSettings

DeleteSettings

CreateServiceRoute

GetServiceRoute

UpdateServiceRoute

ListServiceRoutes

DeleteServiceRoute

CreateServiceRouteRequest

Request to create a ServiceRoute.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the ServiceRoute will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

serviceRoute

tetrateio.api.tsb.traffic.v2.ServiceRoute
REQUIRED
Details of the ServiceRoute to be created.

message = {
  required: true
}

CreateTrafficGroupRequest

Request to create a Traffic Group.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Group will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

group

tetrateio.api.tsb.traffic.v2.Group
REQUIRED
Details of the Group to be created.

message = {
  required: true
}

CreateTrafficSettingsRequest

Request to create a Traffic Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the Traffic Settings will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

settings

tetrateio.api.tsb.traffic.v2.TrafficSetting
REQUIRED
Details of the Traffic Settings to be created.

message = {
  required: true
}

DeleteServiceRouteRequest

Request to delete a ServiceRoute.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the ServiceRoute.

string = {
  min_len: 1
}

DeleteTrafficGroupRequest

Request to delete a Traffic Group.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Group.

string = {
  min_len: 1
}

force

bool
Force the deletion of the object even if deletion protection is enabled. If this is set, then the object and all its children will be deleted even if any of them has the deletion protection enabled.

DeleteTrafficSettingsRequest

Request to delete a Traffic Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Traffic Settings.

string = {
  min_len: 1
}

GetServiceRouteRequest

Request to retrieve a ServiceRoute.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the ServiceRoute.

string = {
  min_len: 1
}

GetTrafficGroupRequest

Request to retrieve a Traffic Group.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Group.

string = {
  min_len: 1
}

GetTrafficSettingsRequest

Request to retrieve a Traffic Settings.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the Traffic Settings.

string = {
  min_len: 1
}

ListServiceRoutesRequest

Request to list ServiceRoutes.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list ServiceRoutes from.

string = {
  min_len: 1
}

ListServiceRoutesResponse

List of all service routes defined in the traffic group.

FieldDescriptionValidation Rule

serviceRoutes

List of tetrateio.api.tsb.traffic.v2.ServiceRoute

ListTrafficGroupsRequest

Request to list Traffic Groups.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Groups from.

string = {
  min_len: 1
}

ListTrafficGroupsResponse

List of all existing traffic groups in the workspace.

FieldDescriptionValidation Rule

groups

List of tetrateio.api.tsb.traffic.v2.Group

ListTrafficSettingsRequest

Request to list Traffic Settings.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list Traffic Settings from.

string = {
  min_len: 1
}

ListTrafficSettingsResponse

List of all existing traffic settings objects in the traffic group.

FieldDescriptionValidation Rule

settings

List of tetrateio.api.tsb.traffic.v2.TrafficSetting