Job Router Administration Operations - Get Exception Policy

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2023-11-01

Pobiera istniejące zasady wyjątków według identyfikatora.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Identyfikator URI zasobu komunikacji
exceptionPolicyId	path	True	string	Identyfikator zasad wyjątku.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

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

Nazwa

Typ

Opis

200 OK

ExceptionPolicy

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

Nagłówki

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

AadOauth2Auth

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://communication.azure.com/.default

Przykłady

Retrieves an existing exception policy by Id

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "MainExceptionPolicy",
  "name": "Main",
  "exceptionRules": [
    {
      "id": "MaxWaitTimeExceeded",
      "trigger": {
        "kind": "waitTime",
        "thresholdSeconds": 20
      },
      "actions": [
        {
          "id": "babd4f6f-916e-4e91-9c89-e0bb05a2c425",
          "kind": "reclassify",
          "classificationPolicyId": "Main",
          "labelsToUpsert": {
            "escalated": 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 dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Akcja, która oznacza zadanie jako anulowane.
ExceptionActionKind	Dyskryminuje obsługiwane typy akcji wyjątków.
ExceptionPolicy	Zasady definiujące akcje do wykonania po wyzwoleniu wyjątku.
ExceptionRule	Reguła definiująca akcje do wykonania na określonym wyzwalaczu.
ExceptionTriggerKind	Dyskryminujące obsługiwane typy wyzwalaczy wyjątków.
LabelOperator	Opisuje obsługiwane operacje na wartościach etykiet.
ManualReclassifyExceptionAction	Akcja, która ręcznie ponownie klasyfikuje zadanie, zapewniając selektory kolejki, priorytetu i procesu roboczego.
QueueLengthExceptionTrigger	Wyzwalacz dla akcji wyjątku w przypadku przekroczenia długości kolejki.
ReclassifyExceptionAction	Akcja, która modyfikuje etykiety w zadaniu, a następnie ponownie je klasyfikuje.
RouterWorkerSelector	Opisuje warunek, który musi zostać spełniony względem zestawu etykiet do wyboru procesu roboczego.
RouterWorkerSelectorStatus	Opisuje stan selektora procesów roboczych.
WaitTimeExceptionTrigger	Wyzwalacz dla akcji wyjątku w przypadku przekroczenia czasu oczekiwania.

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 dotyczącymi 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.

CancelExceptionAction

Akcja, która oznacza zadanie jako anulowane.

Nazwa	Typ	Opis
dispositionCode	string	Wskazuje wynik zadania, wypełnij to pole własnymi wartościami niestandardowymi.
id	string	Unikatowy identyfikator akcji wyjątku.
kind	string: cancel	Dyskryminujący typ opisujący podtyp wyjątkuAkcja.
note	string	Uwaga, która zostanie dołączona do kolekcji notatek zadania z bieżącym znacznikiem czasu.

ExceptionActionKind

Dyskryminuje obsługiwane typy akcji wyjątków.

Nazwa	Typ	Opis
cancel	string	Wartość dyskryminująca dla cancelExceptionAction.
manualReclassify	string	Dyskryminująca wartość ManualReclassifyExceptionAction.
reclassify	string	Wartość dyskryminująca dla klasyfikatora ReclassifyExceptionAction.

ExceptionPolicy

Zasady definiujące akcje do wykonania po wyzwoleniu wyjątku.

Nazwa	Typ	Opis
etag	string	Tag jednostki dla tego zasobu.
exceptionRules	ExceptionRule[]	Kolekcja reguł wyjątków dotyczących zasad wyjątków.
id	string	Identyfikator zasad wyjątku.
name	string	Przyjazna nazwa tych zasad.

ExceptionRule

Reguła definiująca akcje do wykonania na określonym wyzwalaczu.

Nazwa	Typ	Opis
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Kolekcja akcji do wykonania po wyzwoleniu wyjątku.
id	string	Identyfikator reguły wyjątku.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	Wyzwalacz dla tej reguły wyjątku.

ExceptionTriggerKind

Dyskryminujące obsługiwane typy wyzwalaczy wyjątków.

Nazwa	Typ	Opis
queueLength	string	Wartość dyskryminująca dla elementu QueueLengthExceptionTrigger.
waitTime	string	Dyskryminująca wartość WaitTimeExceptionTrigger.

LabelOperator

Opisuje obsługiwane operacje na wartościach etykiet.

Nazwa	Typ	Opis
equal	string	Równy.
greaterThan	string	Większe niż.
greaterThanOrEqual	string	Większe niż lub równe.
lessThan	string	Mniej niż.
lessThanOrEqual	string	Mniejsze niż lub równe.
notEqual	string	Nie równa się.

ManualReclassifyExceptionAction

Akcja, która ręcznie ponownie klasyfikuje zadanie, zapewniając selektory kolejki, priorytetu i procesu roboczego.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator akcji wyjątku.
kind	string: manualReclassify	Dyskryminujący typ opisujący podtyp wyjątkuAkcja.
priority	integer	Zaktualizowany priorytet.
queueId	string	Zaktualizowano identyfikator kolejki.
workerSelectors	RouterWorkerSelector[]	Zaktualizowany proces roboczyWybieracze.

QueueLengthExceptionTrigger

Wyzwalacz dla akcji wyjątku w przypadku przekroczenia długości kolejki.

Nazwa	Typ	Opis
kind	string: queueLength	Dyskryminujący typ opisujący podtyp wyjątkuTrigger.
threshold	integer	Próg liczby zadań z wyprzedzeniem w kolejce do uruchomienia tego wyzwalacza.

ReclassifyExceptionAction

Akcja, która modyfikuje etykiety w zadaniu, a następnie ponownie je klasyfikuje.

Nazwa	Typ	Opis
classificationPolicyId	string	Nowe zasady klasyfikacji, które określą selektory kolejki, priorytetu i procesu roboczego.
id	string	Unikatowy identyfikator akcji wyjątku.
kind	string: reclassify	Dyskryminujący typ opisujący podtyp wyjątkuAkcja.
labelsToUpsert		Słownik zawierający etykiety do zaktualizowania (lub dodania, jeśli nie istnieje) w parach klucz-wartość. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.

RouterWorkerSelector

Opisuje warunek, który musi zostać spełniony względem zestawu etykiet do wyboru procesu roboczego.

Nazwa	Typ	Opis
expedite	boolean	Wypycha zadanie do przodu kolejki, o ile ten selektor jest aktywny.
expiresAfterSeconds	number	Opisuje, jak długo ten selektor etykiet jest prawidłowy w sekundach.
expiresAt	string	Godzina wygaśnięcia tego selektora procesu roboczego w formacie UTC.
key	string	Klucz etykiety do odpytowania.
labelOperator	LabelOperator	Opisuje sposób porównywania wartości etykiety z wartością zdefiniowaną na selektorze procesu roboczego.
status	RouterWorkerSelectorStatus	Stan selektora procesów roboczych.
value		Wartość do porównania z rzeczywistą wartością etykiety z danym operatorem. Wartości muszą być wartościami pierwotnymi — liczba, ciąg, wartość logiczna.

RouterWorkerSelectorStatus

Opisuje stan selektora procesów roboczych.

Nazwa	Typ	Opis
active	string	Selektor procesów roboczych jest prawidłowy.
expired	string	Selektor procesów roboczych jest nieprawidłowy.

WaitTimeExceptionTrigger

Wyzwalacz dla akcji wyjątku w przypadku przekroczenia czasu oczekiwania.

Nazwa	Typ	Opis
kind	string: waitTime	Dyskryminujący typ opisujący podtyp wyjątkuTrigger.
thresholdSeconds	number	Próg czasu oczekiwania dla tego wyzwalacza.

Udostępnij za pośrednictwem

Job Router Administration Operations - Get Exception Policy

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

AadOauth2Auth

Zakresy

Przykłady

Retrieves an existing exception policy by Id

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CancelExceptionAction

ExceptionActionKind

ExceptionPolicy

ExceptionRule

ExceptionTriggerKind

LabelOperator

ManualReclassifyExceptionAction

QueueLengthExceptionTrigger

ReclassifyExceptionAction

RouterWorkerSelector

RouterWorkerSelectorStatus

WaitTimeExceptionTrigger

Dodatkowe zasoby