API Gateway WebSocket Connection Service, gRPC: ConnectionService.Get
Written by
Updated at October 17, 2024
Returns the specified connection info.
gRPC request
rpc Get (GetConnectionRequest) returns (Connection)
GetConnectionRequest
{
"connectionId": "string"
}
|
Field |
Description |
|
connectionId |
string Required field. ID of the connection to get. |
Connection
{
"id": "string",
"gatewayId": "string",
"identity": {
"sourceIp": "string",
"userAgent": "string"
},
"connectedAt": "google.protobuf.Timestamp",
"lastActiveAt": "google.protobuf.Timestamp"
}
|
Field |
Description |
|
id |
string ID of the connection. |
|
gatewayId |
string ID of the API Gateway. |
|
identity |
The information about the caller making the request to API Gateway. |
|
connectedAt |
The timestamp at which connection was established. |
|
lastActiveAt |
The timestamp at which connection was last accessed. |
Identity
|
Field |
Description |
|
sourceIp |
string The source IP address of the caller making the request to API Gateway. |
|
userAgent |
string The User Agent of the caller making the request to API Gateway. |