API Gateway WebSocket Connection Service, REST: Connection.Get
Returns the specified connection info.
HTTP request
GET https://apigateway-connections.api.cloud.yandex.net/apigateways/websocket/v1/connections/{connectionId}
Path parameters
Field |
Description |
connectionId |
string Required field. ID of the connection to get. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"gatewayId": "string",
"identity": {
"sourceIp": "string",
"userAgent": "string"
},
"connectedAt": "string",
"lastActiveAt": "string"
}
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 |
string (date-time) The timestamp at which connection was established. String in RFC3339 To work with values in this field, use the APIs described in the |
lastActiveAt |
string (date-time) The timestamp at which connection was last accessed. String in RFC3339 To work with values in this field, use the APIs described in the |
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. |