Anmelden und Senden von Anforderungen
Dieser Abschnitt enthält ein Beispiel für die Verwendung der RAS REST-API, das Ihnen helfen kann, schnell loszulegen. Das Beispiel zeigt folgende Vorgänge:
- Anmelden bei Parallels RAS und Abrufen eines Sitzungstokens
- Abrufen der Informationen über alle verfügbaren RD-Sitzungshosts
- Abrufen der Informationen über einen bestimmten RD-Sitzungshost
- Ändern der Eigenschaften des RD-Sitzungshosts.
Anmelden bei Parallels RAS und Abrufen eines Sitzungstokens
Bevor Sie auf eine der Ressourcen zugreifen können, müssen Sie sich mit Administrator-Anmeldeinformationen bei Parallels RAS anmelden und ein Sitzungstoken erhalten. Dies geschieht durch das Absenden der folgenden Anfrage:
POST https://<API-host>/api/session/logon
Abfrage-Header: Die Anmeldeabfrage darf nur den Abfrage-Header Content-Type“ enthalten. Nachfolgende Abfragen müssen zusätzlich den auth_token-Header enthalten, wie Sie in den folgenden Beispielen sehen werden.
Content-Type: application/json; api-version=1.0
Abfrage-Hauptteil: Der Abfrage-Hauptteil muss den Benutzernamen und das Passwort des RAS-Administrators enthalten.
{
"username": "USER",
"password": "PASSWORD"
}
Antwort: Nach dem Absenden der Anmeldeanforderung erhalten Sie eine Antwort mit dem Sitzungstoken, den Sie in allen nachfolgenden Abfragen verwenden werden:
{
"authToke n": "Lj+KddoJkANhzvbDRvB=K=DFCroRjXJHeeWGbGlIRKaz-EXplbmhVWvWTiDVqtOq"
}
Abrufen von Informationen über RD-Sitzungshosts
Nachdem Sie den Sitzungstoken haben, können Sie Abfragen senden, um auf verschiedene Ressourcen zuzugreifen. In diesem Beispiel erhalten Sie zunächst die Informationen über alle verfügbaren RD-Sitzungshosts. Im folgenden Beispiel erhalten Sie die Informationen über einen bestimmten RD-Sitzungshost.
Um die Informationen zum RD-Sitzungshost abzurufen, senden Sie die folgende Anfrage:
GET https://<API-host>/api/RDS
Abfrage-Header: Diesmal muss auch der Header der auth_token-Abfrage enthalten sein und den Sitzungstoken enthalten, den wir zuvor erhalten haben.
Content-Type: application/json; api-version=1.0
auth_token: Lj+KddoJkANhzvbDRvB=K=DFCroRjXJHeeWGbGlIRKaz-EXplbmhVWvWTiDVqtOq
Antwort: Die Antwort sieht wie folgt aus (bei mehreren RD-Sitzungshosts in der Farm enthält jeder Block der Ergebnismenge die Informationen über einen einzelnen Server).
[
{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"port": 3389,
"restrictDesktopAccess": false,
"restrictedUsers": [],
"server": "IP_ADDR",
"enabled": true,
"description": "",
"siteId": 1,
"id": 2
}
]
Abrufen der Informationen über einen bestimmten RD-Sitzungshost
Um die Informationen über einen bestimmten Server abzurufen, verwenden wir die gleiche Anfrage wie oben, fügen aber am Ende die Server-ID hinzu:
GET https://<API-host>/api/RDS/2/
Die Antwort wird ebenfalls dem obigen Beispiel ähnlich sein und die Informationen nur für den angegebenen Server enthalten.
Ändern der Eigenschaften des RD-Sitzungshosts
In diesem Beispiel ändern Sie eine Eigenschaft des RD-Sitzungshosts, die wir zuvor abgerufen haben. Der Einfachheit halber ändern Sie das Feld description“.
Die Anforderung, die Eigenschaften eines RD-Sitzungshosts zu ändern, hat folgende Syntax:
PUT https://<API-host>/api/RDS/2/
Beachten Sie die 2“ am Ende der Abfrage, die die ID des RD-Sitzungshosts angibt, den wir ändern möchten.
Abfrage-Header:
- Content-Type: application/json; api-version=1.0
- auth_token: Lj+KddoJkANhzvbDRvB=K=DFCroRjXJHeeWGbGlIRKaz-EXplbmhVWvWTiDVqtOq
Abfrage-Hauptteil:
{
"description": "description was updated!"
}
Antwort: Wenn die PUT-Anfrage erfolgreich war, erhalten Sie eine leere Antwort mit dem Code 204: Kein Inhalt“. Um zu überprüfen, ob das Feld description“ tatsächlich geändert wurde, verwenden Sie die gleiche GET-Anfrage, die Sie zuvor verwendet haben: GET https://<API-host>/api/RDS/2/
Wie Sie sehen, enthält das Ergebnis nun das aktualisierte Feld description“:
[
{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"server": "IP_ADDR",
"enabled": true,
"description": "description was updated!",
"siteId": 1,
"id": 2
}
]