Paraméterek érvényesítése

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

A validate-parameters szabályzat ellenőrzi a fejléc, a lekérdezés vagy az elérési út paramétereit az API-sémára irányuló kérelmekben.

Szabályzatutasítás

<validate-parameters specified-parameter-action="ignore | prevent | detect" unspecified-parameter-action="ignore | prevent | detect" errors-variable-name="variable name"> 
    <headers specified-parameter-action="ignore | prevent | detect" unspecified-parameter-action="ignore | prevent | detect">
        <parameter name="parameter name" action="ignore | prevent | detect" />
    </headers>
    <query specified-parameter-action="ignore | prevent | detect" unspecified-parameter-action="ignore | prevent | detect">
        <parameter name="parameter name" action="ignore | prevent | detect" />
    </query>
    <path specified-parameter-action="ignore | prevent | detect">
        <parameter name="parameter name" action="ignore | prevent | detect" />
    </path>
</validate-parameters>

Attribútumok

Elemek

Műveletek

A tartalomérvényesítési szabályzatok egy vagy több olyan attribútumot tartalmaznak, amelyek egy műveletet határoznak meg, amelyet az API Management hajt végre egy entitás API-kérésben vagy -válaszban való érvényesítésekor az API-séma alapján.

• Műveletet lehet megadni az API-sémában szereplő elemekhez, valamint a szabályzattól függően az API-sémában nem szereplő elemekhez.

• A házirend gyermekelemében megadott művelet felülírja a szülőhöz megadott műveletet.

Elérhető műveletek:

Használat

• Szabályzatszakaszok: bejövő
• Szabályzathatókörök: globális, munkaterület, termék, API, művelet
• Átjárók: klasszikus, v2, használat, saját üzemeltetésű, munkaterület

Használati megjegyzések

• Ez a szabályzat csak egyszer használható egy szabályzatszakaszban.

Naplók

A szabályzat végrehajtása során fellépő érvényesítési hibák részleteit a rendszer naplózza a errors-variable-name szabályzat gyökérelemében található attribútumban context.Variables megadott változóba. Ha egy prevent műveletben konfigurálva van, az érvényesítési hiba blokkolja a további kérések vagy válaszok feldolgozását, és a tulajdonságra context.LastError is propagálja.

A hibák vizsgálatához használjon nyomkövetési szabályzatot a környezeti változók hibáinak az Application Insightsba való naplózásához.

A teljesítmény szempontjai

Az érvényesítési szabályzat hozzáadása hatással lehet az API átviteli sebességére. A következő általános alapelvek érvényesek:

• Minél nagyobb az API-séma mérete, annál alacsonyabb lesz az átviteli sebesség.
• Minél nagyobb a hasznos adat egy kérelemben vagy válaszban, annál alacsonyabb lesz az átviteli sebesség.
• Az API-séma mérete nagyobb hatással van a teljesítményre, mint a hasznos adat méretére.
• A több megabájt méretű API-sémán való érvényesítés bizonyos feltételek mellett kérés- vagy válaszidőkorlátokat okozhat. A hatás hangsúlyosabb a szolgáltatás használat ésfejlesztői szintjeiben.

Javasoljuk, hogy a várt éles számítási feladatokkal végezzen terhelésteszteket az érvényesítési szabályzatok API-átviteli sebességre gyakorolt hatásának felméréséhez.

Példa

Ebben a példában a rendszer az összes lekérdezési és elérési útvonalparamétert érvényesíti a megelőzési módban, a fejléceket pedig észlelési módban. Az ellenőrzés felül van bírálva több fejlécparaméter esetében:

<validate-parameters specified-parameter-action="prevent" unspecified-parameter-action="prevent" errors-variable-name="requestParametersValidation"> 
    <headers specified-parameter-action="detect" unspecified-parameter-action="detect">
        <parameter name="Authorization" action="prevent" />
        <parameter name="User-Agent" action="ignore" />
        <parameter name="Host" action="ignore" />
        <parameter name="Referrer" action="ignore" />
    </headers>   
</validate-parameters>

Ellenőrzési hibák

Az API Management a következő formátumban hoz létre tartalomérvényesítési hibákat:

{
 "Name": string,
 "Type": string,
 "ValidationRule": string,
 "Details": string,
 "Action": string
}

Az alábbi táblázat az érvényesítési szabályzatok összes lehetséges hibáját felsorolja.

• Részletek: A hibák kivizsgálására használható. Nem nyilvános megosztásra szánták.
• Nyilvános válasz: Az ügyfélnek visszaadott hiba. Nem szivárognak ki a megvalósítás részletei.

Ha egy érvényesítési szabályzat megadja a prevent műveletet, és hibát okoz, az API management válasza tartalmaz egy HTTP-állapotkódot: 400, ha a szabályzatot a bejövő szakaszban alkalmazza, és 502, amikor a szabályzatot a kimenő szakaszban alkalmazza a rendszer.

Az alábbi táblázat az érvényesítési hiba összes lehetséges okértékét és a lehetséges üzenetértékeket sorolja fel:

Kapcsolódó szabályzatok

• Tartalomérvényesítés

Kapcsolódó tartalom

A szabályzatok használatával kapcsolatos további információkért lásd:

• Oktatóanyag: AZ API átalakítása és védelme
• Szabályzathivatkozás a szabályzatutasságok és azok beállításainak teljes listájához
• Házirend-kifejezések
• Házirendek beállítása vagy szerkesztése
• Szabályzatkonfigurációk újrafelhasználása
• Szabályzatrészletek adattára
• Azure API Management policy toolkit
• Szabályzatok létrehozása a Microsoft Copilot használatával az Azure-ban