Job Router Operations - Get Worker

Service:

Communication

API Version:

2023-11-01

Pobiera istniejący proces roboczy według identyfikatora.

GET {endpoint}/routing/workers/{workerId}?api-version=2023-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Identyfikator URI zasobu komunikacji
workerId	path	True	string	Identyfikator procesu roboczego.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RouterWorker	Żądanie zakończyło się pomyślnie. Headers ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Headers x-ms-error-code: string

Przykłady

Retrieves an existing worker by Id

Sample Request

HTTP

GET https://contoso.westus.communications.azure.com/routing/workers/DefaultWorker?api-version=2023-11-01

Sample Response

Status code:

200

{
  "id": "DefaultWorker",
  "state": "active",
  "queues": [
    "MainQueue",
    "SecondaryQueue"
  ],
  "capacity": 100,
  "labels": {},
  "tags": {},
  "channels": [
    {
      "channelId": "CustomChatChannel",
      "capacityCostPerJob": 10,
      "maxNumberOfJobs": 4
    },
    {
      "channelId": "CustomVoiceChannel",
      "capacityCostPerJob": 100,
      "maxNumberOfJobs": 1
    }
  ],
  "offers": [],
  "assignedJobs": [],
  "loadRatio": 0,
  "availableForOffers": true,
  "etag": "etag"
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterChannel	Reprezentuje pojemność zadania w tym kanale, które będzie zużywać z procesu roboczego.
RouterJobOffer	Oferta pracy dla pracownika.
RouterWorker	Jednostka, do którą mają być kierowane zadania.
RouterWorkerAssignment	Przypisanie procesu roboczego do zadania.
RouterWorkerState	Wyliczenia dla stanów procesów roboczych.

Azure.Core.Foundations.Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

RouterChannel

Reprezentuje pojemność zadania w tym kanale, które będzie zużywać z procesu roboczego.

Nazwa	Typ	Opis
capacityCostPerJob	integer	Ilość pojemności zużywanej przez wystąpienie zadania tego kanału całkowitej pojemności procesu roboczego.
channelId	string	Identyfikator kanału.
maxNumberOfJobs	integer	Maksymalna liczba zadań, które mogą być obsługiwane współbieżnie dla tego kanału. Wartość musi być większa niż zero.

RouterJobOffer

Oferta pracy dla pracownika.

Nazwa	Typ	Opis
capacityCost	integer	Koszt pojemności wykorzystany przez ofertę zadania.
expiresAt	string	Sygnatura czasowa, kiedy oferta wygaśnie w formacie UTC.
jobId	string	Identyfikator zadania.
offerId	string	Identyfikator oferty.
offeredAt	string	Sygnatura czasowa utworzenia oferty w formacie UTC.

RouterWorker

Jednostka, do którą mają być kierowane zadania.

Nazwa	Typ	Opis
assignedJobs	RouterWorkerAssignment[]	Lista przypisanych zadań dołączonych do tego procesu roboczego.
availableForOffers	boolean	Flaga wskazująca, że ten proces roboczy jest otwarty, aby otrzymywać oferty lub nie.
capacity	integer	Łączny wynik wydajności tego procesu roboczego musi zarządzać wieloma współbieżnych zadań.
channels	RouterChannel[]	Kolekcja kanałów, które może obsłużyć ten proces roboczy i ich wpływ na wydajność pracowników.
etag	string	Tag jednostki dla tego zasobu.
id	string	Identyfikator procesu roboczego.
labels		Zestaw par klucz/wartość identyfikujących atrybuty używane przez aparaty reguł do podejmowania decyzji. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.
loadRatio	number	Wartość wskazująca pojemność pracowników. Wartość "1" oznacza, że jest zużywana cała pojemność. Wartość "0" oznacza, że obecnie nie jest zużywana żadna pojemność.
offers	RouterJobOffer[]	Lista aktywnych ofert wystawionych dla tego procesu roboczego.
queues	string[]	Kolekcja kolejek, z których ten proces roboczy może odbierać pracę.
state	RouterWorkerState	Bieżący stan procesu roboczego.
tags		Zestaw atrybutów nieidentyfikacyjnych dołączonych do tego procesu roboczego. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.

RouterWorkerAssignment

Przypisanie procesu roboczego do zadania.

Nazwa	Typ	Opis
assignedAt	string	Czas przypisania zadania w formacie UTC.
assignmentId	string	Identyfikator przypisania.
capacityCost	integer	Ilość pojemności zużywanej przez to przypisanie w ramach procesu roboczego.
jobId	string	Identyfikator przydzielonego zadania.

RouterWorkerState

Wyliczenia dla stanów procesów roboczych.

Nazwa	Typ	Opis
active	string	Proces roboczy jest aktywny i jest dostępny do skorzystania z ofert.
draining	string	Proces roboczy nie jest aktywny, jeśli istnieją oferty, które są odwoływane. Nie są wysyłane żadne nowe oferty.
inactive	string	Proces roboczy nie jest aktywny. Nie są wysyłane żadne nowe oferty.