Job Router Operations - List Workers

Odwołanie

Service:: Communication

API Version:: 2023-11-01

Pobiera istniejące procesy robocze.

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

With optional parameters:

GET {endpoint}/routing/workers?api-version=2023-11-01&maxpagesize={maxpagesize}&state={state}&channelId={channelId}&queueId={queueId}&hasCapacity={hasCapacity}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Identyfikator URI zasobu komunikacji
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
channelId	query		string	Jeśli zostanie określony, wybierz pracowników, którzy mają konfigurację kanału z tym kanałem.
hasCapacity	query		boolean	W przypadku ustawienia wartości true wybierz tylko procesy robocze, które mają pojemność kanału określonego przez `channelId` program lub dla dowolnego kanału, jeśli `channelId` nie zostanie określony. Jeśli zostanie ustawiona wartość false, zostanie zwrócona cała liczba pracowników, w tym pracowników bez możliwości wykonywania zadań. Wartość domyślna to false.
maxpagesize	query		integer int32	Liczba obiektów do zwrócenia na stronę.
queueId	query		string	W przypadku określenia wybierz pracowników, którzy są przypisani do tej kolejki.
state	query		RouterWorkerStateSelector	W przypadku określenia wybierz pozycję Procesy robocze według stanu procesu roboczego.

Odpowiedzi

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

Nazwa

Typ

Opis

200 OK

PagedRouterWorker

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Headers

x-ms-error-code: string

Przykłady

Retrieves available worker filtered by channel

Retrieves list of workers

Retrieves available worker filtered by channel

Sample Request

HTTP

GET https://contoso.westus.communications.azure.com/routing/workers?api-version=2023-11-01&state=active&channelId=CustomChatChannel&hasCapacity=True

Sample Response

Status code:: 200

{
  "value": [
    {
      "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"
    },
    {
      "id": "SecondWorker",
      "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"
    }
  ],
  "nextLink": null
}

Retrieves list of workers

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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"
    },
    {
      "id": "SecondWorker",
      "state": "active",
      "queues": [
        "MainQueue",
        "SecondaryQueue"
      ],
      "capacity": 100,
      "labels": {},
      "tags": {},
      "channels": [
        {
          "channelId": "CustomEmailChannel",
          "capacityCostPerJob": 10,
          "maxNumberOfJobs": 4
        },
        {
          "channelId": "CustomSMSChannel",
          "capacityCostPerJob": 100,
          "maxNumberOfJobs": 1
        }
      ],
      "offers": [],
      "assignedJobs": [],
      "loadRatio": 0,
      "availableForOffers": true,
      "etag": "etag"
    }
  ],
  "nextLink": null
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt error.
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 MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedRouterWorker	Stronicowana kolekcja elementów RouterWorker
RouterChannel	Reprezentuje pojemność, która będzie zużywać zadanie w tym kanale 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.
RouterWorkerStateSelector	W przypadku określenia wybierz pozycję Procesy robocze według stanu procesu roboczego.

Azure.Core.Foundations.Error

Obiekt error.

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 error.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — 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.

PagedRouterWorker

Stronicowana kolekcja elementów RouterWorker

Nazwa	Typ	Opis
nextLink	string	Link do następnej strony elementów
value	RouterWorker[]	Elementy RouterWorker na tej stronie

RouterChannel

Reprezentuje pojemność, która będzie zużywać zadanie w tym kanale 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 zużywany przez ofertę zadania.
expiresAt	string	Znacznik czasu wygaśnięcia oferty 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.
capacity	integer	Łączny wynik pojemności, który ten proces roboczy musi zarządzać wieloma współbieżnych zadań.
channels	RouterChannel[]	Kolekcja kanałów, które ten proces roboczy może obsłużyć, oraz ich wpływ na wydajność procesów roboczych.
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ść procesów roboczych. 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 niezwiązanych z identyfikacją 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 uż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 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.

RouterWorkerStateSelector

W przypadku określenia wybierz pozycję Procesy robocze według stanu procesu roboczego.

Nazwa	Typ	Opis
active	string	Proces roboczy jest aktywny i dostępny do skorzystania z ofert.
all	string	Proces roboczy jest aktywny lub nieaktywny.
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.

Udostępnij za pośrednictwem

Job Router Operations - List Workers

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Retrieves available worker filtered by channel

Sample Request

Sample Response

Retrieves list of workers

Sample Request

Sample Response

Definicje

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

PagedRouterWorker

RouterChannel

RouterJobOffer

RouterWorker

RouterWorkerAssignment

RouterWorkerState

RouterWorkerStateSelector

Dodatkowe zasoby