API Gateway WebSocket Connection Service, gRPC: ConnectionService.Get
Written by
Updated at November 26, 2024
Returns the specified connection info.
gRPC request
rpc Get (GetConnectionRequest) returns (Connection)
GetConnectionRequest
{
"connection_id": "string"
}
|
Field |
Description |
|
connection_id |
string Required field. ID of the connection to get. |
Connection
{
"id": "string",
"gateway_id": "string",
"identity": {
"source_ip": "string",
"user_agent": "string"
},
"connected_at": "google.protobuf.Timestamp",
"last_active_at": "google.protobuf.Timestamp"
}
|
Field |
Description |
|
id |
string ID of the connection. |
|
gateway_id |
string ID of the API Gateway. |
|
identity |
The information about the caller making the request to API Gateway. |
|
connected_at |
The timestamp at which connection was established. |
|
last_active_at |
The timestamp at which connection was last accessed. |
Identity
|
Field |
Description |
|
source_ip |
string The source IP address of the caller making the request to API Gateway. |
|
user_agent |
string The User Agent of the caller making the request to API Gateway. |