Retrieve Connection Status
get
http://{host}:{port}/veridata/v1/services/configuration/connections/{Id}/status
Required Role: Administrator, SuperUser, DetailMonitoringOperator, MonitoringOperator, CommandLineOperator
Get the connection status.
Request
Path Parameters
- Id(required): integer(int64) agent connection ID.
Query Parameters
- type: string Type of connection to be tested. Agent or DB, or both. Default is both.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
connection status.
Root Schema : schema
Type:
integerO means DOWN , 1 means UP and 2 means UNKNOWN.
Allowed Values:
[ 0, 1, 2 ]Example:
1400 Response
Bad Request.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }401 Response
Unauthorized.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }404 Response
Not Found.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }500 Response
Server Error.
Root Schema : Error
Type:
Show Source object- errCode: string Veridata Error Code.
- errMsg: string Veridata Error Message.
Example:
{ "errCode":"OGGV-00001", "errMsg":"Error message" }