Rufen Sie die Mandantenroboterzuteilung ab

GET-Endpunkt zum Abrufen der Anzahl der Roboter-Runtimes, die einem bestimmten Mandanten zugewiesen sind und von ihm verwendet werden.

Ruft die Anzahl der Unattended Robot-Runtimes ab, die einem bestimmten Mandanten zugeordnet sind, und, falls verfügbar, wie viele davon derzeit verwendet werden. Die Anzahl der in Verwendung befindlichen Elemente wird bei jedem Aufruf live aus dem Orchestrator gelesen. Erfordert eine der folgenden Optionen:

• Eine externe Anwendung mit dem Scope PM.License.Read (oder PM.License). Erfahren Sie, wie Sie eine externe Anwendung erstellen.
• Ein Administratorbenutzertoken für eine Organisation.
• Ein internes Dienst-zu-Dienst-Token.

API-Endpunkt

GET {accessURL}/{organizationName}/license_/api/account/{accountId}/tenant/{tenantId}/robots

Ersetzen Sie {accessURL} in allen Endpunktpfaden durch die Basis-URL für Ihre Cloud-Plattform:

Cloud Platform	Zugriffs-URL
Test Cloud	https://cloud.uipath.com/
Test Cloud Public Sector	https://govcloud.uipath.us/
Test Cloud Dedicated.	https://{customURL}.dedicated.uipath.com/

Hinweis:

{organizationName} und {accountId} identifizieren beide dieselbe Organisation: {organizationName} ist der Organisationsname im Präfix für das URL-Routing, während {accountId} die Organisations-ID (GUID) ist, die als Pfadparameter verwendet wird. Die Organisations-ID wird auch im Routingpräfix akzeptiert, wie in jeder Standard-URL.

Anforderungsheader

--header 'Authorization: Bearer {access_token}'

Hinweis:

Um das {access_token} für eine externe Anwendung zu erhalten, authentifizieren Sie sich mit der Gewährung von Client-Anmeldeinformationen, wie auf der Seite Authentifizierungsmethoden beschrieben.

Pfadparameter

Pfadparameter	Datentyp	Beschreibung
accountId (erforderlich)	GUID	Die ID der Organisation, in der sich der Mandant befindet.
tenantId (erforderlich)	GUID	Die ID des Mandanten, für den die Roboterzuweisung abgerufen werden soll.

Antworten

200 OK

Gibt die Roboterzuweisung für den angegebenen Mandanten zurück.

• serviceScopeId: Die Mandanten-ID aus der Anforderung.
• serviceType: immer orchestrator.
• usageAvailable: true, wenn die Anzahl der verwendeten Anzahlen vom Orchestrator abgerufen wurde. false wenn der Orchestrator nicht erreicht werden konnte; In diesem Fall wird inUse bei jedem Eintrag in robots weggelassen, sodass die nicht verfügbare Nutzung nie als Null gemeldet wird.
• robots: Für jeden Unattended-Robotertyp, der dem Mandanten zugeordnet ist, die zugewiesene Menge (allocated) und, falls verfügbar, die aktuell verwendete Menge (inUse). Es werden nur Produkte aufgelistet, die dem Mandanten zugeordnet sind. Die verfügbaren Codes finden Sie unter Roboter .

robots wird als leeres Array zurückgegeben, wobei usageAvailable auf false festgelegt ist, wenn der Mandant über keine Orchestrator-Dienstlizenz verfügt oder keine Unattended-Roboter-Lizenzen zugewiesen sind. In diesem Fall erfolgt kein Aufruf des Orchestrators.

Hinweis:

Dieser Endpunkt deckt nur Unattended Robot-Runtimes ab (UNATT, NONPR, UNATT-HOSTING, TAUNATT, APPTESTR). Attended- und andere Named-User-Lizenzen sind nicht enthalten, da es sich um Benutzerlizenzen und keine Runtimes handelt. Gibt auch die Zuweisung für einen Mandanten pro Aufruf zurück: Um die Roboterzuweisung für jeden Mandanten in einer Organisation abzurufen, rufen Sie den Endpunkt einmal pro Mandant auf.

Beispielanforderung

Die Anfrage sollte wie im folgenden Beispiel aussehen (cURL):

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/license_/api/account/11111111-1111-1111-1111-111111111111/tenant/22222222-2222-2222-2222-222222222222/robots' \
--header 'Authorization: Bearer {access_token}'

Hier ist der Antworttext für einen erfolgreichen Abruf der Roboterzuweisung:

{
  "serviceScopeId": "22222222-2222-2222-2222-222222222222",
  "serviceType": "orchestrator",
  "usageAvailable": true,
  "robots": [
    { "code": "UNATT", "allocated": 10, "inUse": 3 },
    { "code": "NONPR", "allocated": 2, "inUse": 0 }
  ]
}