Groups
- Last UpdatedJul 11, 2023
- 3 minute read
API for Client Failover Groups.
List Group Configurations
Returns the list of failover groups.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/clientfailover/groups
?skip={skip}&count={count}
Parameters
string tenantId
string namespaceId
[optional] integer skip
The number of items to skip.[optional] integer count
The number of items to return.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | GroupConfiguration[] | A list of failover groups. |
| 400 | ErrorResponse | Request is not valid. See the response body for additional details. |
| 403 | ErrorResponse | Request is not authorized. |
| 503 | ErrorResponse | Service unavailable. |
Response Headers
| Status | Header | Type | Description |
|---|---|---|---|
| 200 | Total-Count | integer | Total number of failover groups. |
Example response body
200 Response (GroupConfiguration[])
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"FailoverTimeout": "string",
"AdditionalData": {
"property1": null,
"property2": null
}
}
]
Post Group
Creates a failover group.
Request
POST /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/clientfailover/groups
Parameters
string tenantId
string namespaceId
Request Body
The configuration of the failover group being created or updated.
{
"Id": "string",
"Name": "string",
"Description": "string",
"FailoverTimeout": "string",
"AdditionalData": {
"property1": null,
"property2": null
}
}
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | GroupConfiguration | Failover group with matching id and configuration exists. |
| 201 | GroupConfiguration | The failover group was created. |
| 400 | ErrorResponse | Request is not valid. See the response body for additional details. |
| 403 | ErrorResponse | Request is not authorized. |
| 409 | ErrorResponse | Group already exists with different configuration. |
| 503 | ErrorResponse | Service unavailable. |
Example response body
200 Response (GroupConfiguration)
{
"Id": "string",
"Name": "string",
"Description": "string",
"FailoverTimeout": "string",
"AdditionalData": {
"property1": null,
"property2": null
}
}
Get Group Configuration
Gets a failover group by identifier.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/clientfailover/groups/{groupId}
Parameters
string tenantId
string namespaceId
string groupId
The identifier of the failover group.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | GroupConfiguration | Failover group with the specified identifier. |
| 400 | ErrorResponse | Request is not valid. See the response body for additional details. |
| 403 | ErrorResponse | Request is not authorized. |
| 404 | ErrorResponse | A failover group with the specified identifier was not found. |
| 503 | ErrorResponse | Service unavailable. |
Example response body
200 Response (GroupConfiguration)
{
"Id": "string",
"Name": "string",
"Description": "string",
"FailoverTimeout": "string",
"AdditionalData": {
"property1": null,
"property2": null
}
}
Delete Group
Deletes a failover group by identifier.
Request
DELETE /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/clientfailover/groups/{groupId}
Parameters
string tenantId
string namespaceId
string groupId
The identifier of the failover group.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 204 | None | The failover group was deleted. |
| 400 | ErrorResponse | Request is not valid. See the response body for additional details. |
| 403 | ErrorResponse | Request is not authorized. |
| 404 | ErrorResponse | A failover group with the specified identifier was not found. |
| 409 | ErrorResponse | The failover group has active sessions and cannot be deleted. |
| 503 | ErrorResponse | Service unavailable. |
Get Group Status
Gets the failover group status.
Request
GET /api/v1/tenants/{tenantId}/namespaces/{namespaceId}/clientfailover/groups/{groupId}/status
Parameters
string tenantId
string namespaceId
string groupId
The identifier of the failover group.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | IGroupStatus | The failover group status. |
| 400 | ErrorResponse | Request is not valid. See the response body for additional details. |
| 403 | ErrorResponse | Request is not authorized. |
| 404 | ErrorResponse | A failover group with the specified identifier was not found. |
| 503 | ErrorResponse | Service unavailable. |
Example response body
200 Response (IGroupStatus)
{
"Primary": "string",
"PendingPrimary": "string",
"LastDataProcessedTime": "2019-08-24T14:15:22Z"
}
Definitions
GroupConfiguration
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Id | string | false | true | Unique group identifier |
| Name | string | false | true | Friendly name of group |
| Description | string | false | true | Description of group |
| FailoverTimeout | time-span | false | false | Amount of time after which a client is considered inactive |
| AdditionalData | object | false | true | Additional group data. |
{
"Id": "string",
"Name": "string",
"Description": "string",
"FailoverTimeout": "string",
"AdditionalData": {
"property1": null,
"property2": null
}
}
ErrorResponse
Response error for controller methods.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | false | true | Operation identifier |
| Error | string | false | true | Error string |
| Reason | string | false | true | Error reason string |
| Resolution | string | false | true | Resolution string |
| AdditionalParameters | object | false | true | Additional parameters to add to the response. |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string",
"AdditionalParameters": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
IGroupStatus
Group status.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| Primary | string | false | true | Unique client session identifier for the primary client |
| PendingPrimary | string | false | true | Unique client session identifier for the pending primary client |
| LastDataProcessedTime | date-time | false | true | Time when last data was processed by primary |
{
"Primary": "string",
"PendingPrimary": "string",
"LastDataProcessedTime": "2019-08-24T14:15:22Z"
}