Job Router Administration Operations - Get Exception Policy

Reference

Služba:: Communication

Verze rozhraní API:: 2023-11-01

Načte existující zásadu výjimky podle ID.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Identifikátor URI vašeho komunikačního prostředku
exceptionPolicyId	path	True	string	ID zásady výjimky.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ExceptionPolicy	Požadavek byl úspěšný. Hlavičky ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

ExceptionPolicy

Požadavek byl úspěšný.

Hlavičky

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

AadOauth2Auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

Name	Description
https://communication.azure.com/.default

Příklady

Retrieves an existing exception policy by Id

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelExceptionAction	Akce, která označí úlohu jako zrušenou
ExceptionActionKind	Diskriminátory podporovaných typů akcí výjimek.
ExceptionPolicy	Zásada, která definuje akce, které se mají provést při aktivaci výjimky.
ExceptionRule	Pravidlo, které definuje akce, které se mají provést na konkrétní aktivační události.
ExceptionTriggerKind	Diskriminátory podporovaných typů aktivačních událostí výjimek.
LabelOperator	Popisuje podporované operace s hodnotami popisků.
ManualReclassifyExceptionAction	Akce, která ručně přetřídí úlohu poskytnutím fronty, priority a selektorů pracovních procesů.
QueueLengthExceptionTrigger	Aktivace akce výjimky při překročení délky fronty
ReclassifyExceptionAction	Akce, která upraví popisky úlohy, a pak ji znovu klasifikuje.
RouterWorkerSelector	Popisuje podmínku, která musí být splněna u sady popisků pro výběr pracovního procesu.
RouterWorkerSelectorStatus	Popisuje stav selektoru pracovního procesu.
WaitTimeExceptionTrigger	Aktivace akce výjimky při překročení doby čekání

Azure.Core.Foundations.Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

CancelExceptionAction

Akce, která označí úlohu jako zrušenou

Name	Typ	Description
dispositionCode	string	Označuje výsledek úlohy a naplní toto pole vlastními hodnotami.
id	string	Jedinečné ID akce výjimky.
kind	string: cancel	Typ diskriminující popis dílčího typu ExceptionAction.
note	string	Poznámka, která se připojí ke kolekci poznámek úlohy s aktuálním časovým razítkem.

ExceptionActionKind

Diskriminátory podporovaných typů akcí výjimek.

Name	Typ	Description
cancel	string	Diskriminující hodnota pro CancelExceptionAction.
manualReclassify	string	Diskriminující hodnota pro ManualReclassifyExceptionAction.
reclassify	string	Diskriminující hodnota pro ReclassifyExceptionAction.

ExceptionPolicy

Zásada, která definuje akce, které se mají provést při aktivaci výjimky.

Name	Typ	Description
etag	string	Značka entity pro tento prostředek.
exceptionRules	ExceptionRule[]	Kolekce pravidel výjimek pro zásady výjimek.
id	string	ID zásady výjimky.
name	string	Popisný název této zásady

ExceptionRule

Pravidlo, které definuje akce, které se mají provést na konkrétní aktivační události.

Name	Typ	Description
actions	ExceptionAction[]: CancelExceptionAction[] ManualReclassifyExceptionAction[] ReclassifyExceptionAction[]	Kolekce akcí, které se mají provést po aktivaci výjimky.
id	string	ID pravidla výjimky.
trigger	ExceptionTrigger: QueueLengthExceptionTrigger WaitTimeExceptionTrigger	Aktivační událost pro toto pravidlo výjimky.

ExceptionTriggerKind

Diskriminátory podporovaných typů aktivačních událostí výjimek.

Name	Typ	Description
queueLength	string	Diskriminující hodnota pro QueueLengthExceptionTrigger.
waitTime	string	Diskriminující hodnota pro WaitTimeExceptionTrigger.

LabelOperator

Popisuje podporované operace s hodnotami popisků.

Name	Typ	Description
equal	string	Rovný.
greaterThan	string	Větší než.
greaterThanOrEqual	string	Větší než nebo rovno.
lessThan	string	Méně než.
lessThanOrEqual	string	Menší než nebo rovno.
notEqual	string	Nerovná se.

ManualReclassifyExceptionAction

Akce, která ručně přetřídí úlohu poskytnutím fronty, priority a selektorů pracovních procesů.

Name	Typ	Description
id	string	Jedinečné ID akce výjimky.
kind	string: manualReclassify	Typ diskriminující popis dílčího typu ExceptionAction.
priority	integer	Aktualizace priority.
queueId	string	Aktualizace QueueId.
workerSelectors	RouterWorkerSelector[]	Aktualizované pracovní výběry.

QueueLengthExceptionTrigger

Aktivace akce výjimky při překročení délky fronty

Name	Typ	Description
kind	string: queueLength	Typ diskriminující popis podtypu ExceptionTrigger.
threshold	integer	Prahová hodnota počtu úloh před frontou, aby se tento trigger aktivoval.

ReclassifyExceptionAction

Akce, která upraví popisky úlohy, a pak ji znovu klasifikuje.

Name	Typ	Description
classificationPolicyId	string	Nové zásady klasifikace, které určují frontu, prioritu a selektory pracovních procesů.
id	string	Jedinečné ID akce výjimky.
kind	string: reclassify	Typ diskriminující popis dílčího typu ExceptionAction.
labelsToUpsert		Slovník obsahující popisky, které se mají aktualizovat (nebo přidat, pokud neexistují) ve dvojicích klíč-hodnota. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.

RouterWorkerSelector

Popisuje podmínku, která musí být splněna u sady popisků pro výběr pracovního procesu.

Name	Typ	Description
expedite	boolean	Nasdílí úlohu do fronty, pokud je tento selektor aktivní.
expiresAfterSeconds	number	Popisuje, jak dlouho je tento selektor popisků platný v sekundách.
expiresAt	string	Čas vypršení platnosti tohoto selektoru pracovního procesu ve standardu UTC.
key	string	Klíč popisku pro dotazování.
labelOperator	LabelOperator	Popisuje, jak se hodnota popisku porovnává s hodnotou definovanou v selektoru pracovního procesu.
status	RouterWorkerSelectorStatus	Stav selektoru pracovního procesu
value		Hodnota, která se má porovnat se skutečnou hodnotou popisku s daným operátorem. Hodnoty musí být primitivní hodnoty – číslo, řetězec, logická hodnota.

RouterWorkerSelectorStatus

Popisuje stav selektoru pracovního procesu.

Name	Typ	Description
active	string	Selektor pracovního procesu je platný.
expired	string	Selektor pracovního procesu není platný.

WaitTimeExceptionTrigger

Aktivace akce výjimky při překročení doby čekání

Name	Typ	Description
kind	string: waitTime	Typ diskriminující popis podtypu ExceptionTrigger.
thresholdSeconds	number	Prahová hodnota pro dobu čekání pro tento trigger

Sdílet prostřednictvím

Job Router Administration Operations - Get Exception Policy

Parametry identifikátoru URI

Odpovědi

Zabezpečení

AadOauth2Auth

Rozsahy

Příklady

Retrieves an existing exception policy by Id

Ukázkový požadavek

Ukázková odpověď

Definice

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CancelExceptionAction

ExceptionActionKind

ExceptionPolicy

ExceptionRule

ExceptionTriggerKind

LabelOperator

ManualReclassifyExceptionAction

QueueLengthExceptionTrigger

ReclassifyExceptionAction

RouterWorkerSelector

RouterWorkerSelectorStatus

WaitTimeExceptionTrigger

Další materiály