Get RDS Server Monitors

Gets monitoring information related to RDS Server.

Request

URI

GET

https://{api_host}//localhost/rest/monitor/v1/rds-servers/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns RDSServerMonitorInfo of type(s) */*

{
    "details": {
        "agent_build": 4445678,
        "agent_version": "7.9.0",
        "max_sessions_count_configured": 123,
        "operating_system": "WINDOWS_SERVER_2016",
        "state": "AVAILABLE"
    },
    "enabled": true,
    "farm_id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
    "id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed50",
    "load_index": 60,
    "load_preference": "NORMAL",
    "name": "rds-server.example.com",
    "session_count": 35,
    "status": "OK"
}

RDSServerMonitorDetails

details

Optional

details

boolean

enabled

Optional

Indicates if RDS server is enabled.

string

farm_id

Optional

Indicates the Farm ID to which the RDS Server belongs to.

string

Optional

Unique ID of the RDS server.

integer As int32 As int32

load_index

Optional

This value is similar to load_preference and represents the load on RDS Server in the range of 0 to 100.

string

load_preference

Optional

Based on the current load of this RDS Server, gives a measure of how preferential this server is to be chosen for new application sessions.

BLOCK: RDS Server is blocked and new sessions will not be accepted.
HEAVY: RDS Server is experiencing heavy load and should likely not be chosen for new sessions.
NORMAL: RDS Server is experiencing normal load and is okay to be chosen for new sessions.
LIGHT: RDS Server is experiencing light load and is okay to be chosen for new sessions.
UNKNOWN: RDS Server did not report a load preference. This is potentially a configuration issue if other RDS Servers in the same Farm do report load preferences.

Possible values are : BLOCK, HEAVY, NORMAL, LIGHT, UNKNOWN,

string

name

Optional

RDS Server name.

integer As int32 As int32

session_count

Optional

RDS server session count.

string

status

Optional

RDS server status.

OK: RDS Server is reachable. All applications (defined on its farm) are verified installed on the RDS Server.
WARNING: RDS Server is reachable. Some applications are detected as not installed on the RDS Server.
ERROR: RDS Server is unreachable, or, none of the applications are installed.
DISABLED: RDS Server is disabled.

Possible values are : OK, WARNING, ERROR, DISABLED,

401

User is not authenticated

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Authentication