/instance/list
- Vijayganesh Sivaprakasam
List linked instances
Request
HTTP Method: POST
Content Type: application/json
Parameters
None.
{
"params": {}
}Response
HTTP Status: 200
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| object of type | instance/list response |
| boolean | response with error or not |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
instance_list_response
Property | Type | Description |
|---|---|---|
| array of instance | list of instances |
instance
Property | Type | Description |
|---|---|---|
| string | authentication type (possible values: 'SQL' and 'WIN') |
| string | host running instance |
| string | name of instance |
| string(date-time) | last connection attempt time in UTC |
| integer | port number of instance |
| string | reason for unconnected instance |
| string | instance running state (possible values: 'Unknown', 'Connected', 'Disconnected' and 'Disabled') |
| integer | total connection attempts |
| string | user name for authentication to instance |
{
"error": {
"message": "string"
},
"result": {
"instances": [
{
"authentication_type": "SQL",
"host": "string",
"instance_name": "string",
"last_attempt_time": "2024-07-31T13:57:42.000123456Z",
"port": 123,
"reason": "string",
"state": "Unknown",
"total_attempts": 123,
"username": "string"
}
]
},
"successful": true
}HTTP Status: 400
Content Type: application/json
Response
Property | Type | Description |
|---|---|---|
| object of type | error response |
| boolean | always false |
error_response
Property | Type | Description |
|---|---|---|
| string | error message |
{
"error": {
"message": "string"
},
"successful": false
}