Google menggunakan teknologi AI untuk menerjemahkan konten ke dalam bahasa pilihan Anda. Terjemahan AI mungkin mengandung kesalahan.

Referensi error kebijakan

Anda melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Kebijakan AccessControl

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`accesscontrol.IPDeniedAccess`	403	The client IP address, or an IP address passed in the API request, matches an IP address specified in the `<SourceAddress>` element within the `<MatchRule>` element of the Access Control Policy, and the `action` attribute of the `<MatchRule>` element is set to `DENY`.

Fault variables

These variables are set when a runtime error occurs. For more information, see Variables specific to policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "IPDeniedAccess"`
`acl.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`acl.AC-AllowAccess.failed = true`

Example fault response

Note: For fault handling, the best practice is to trap the errorcode part of the fault response. Do not rely on the text in the faultstring because it could change.

{
   "fault":{
     "faultstring":"Access Denied for client ip : 52.211.243.3"
      "detail":{
         "errorcode":"accesscontrol.IPDeniedAccess"
      }
   }
}

Example fault rule

<FaultRule name="IPDeniedAccess">
    <Step>
        <Name>AM-IPDeniedAccess</Name>
        <Condition>(fault.name Matches "IPDeniedAccess") </Condition>
    </Step>
    <Condition>(acl.failed = true) </Condition>
</FaultRule>

Kebijakan AccessEntity

Untuk informasi terkait, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Tidak ada.

Error saat deployment

Nama error	String error	Status HTTP	Terjadi saat
`InvalidEntityType`	`Invalid type [entity_type] in ACCESSENTITYStepDefinition [policy_name]`	T/A	Jenis entitas yang digunakan harus berupa salah satu jenis yang didukung.

Kebijakan AssignMessage

Bagian ini menjelaskan kode kesalahan dan pesan kesalahan yang dikembalikan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu kesalahan. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Penanganan kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error Status HTTP Penyebab Perbaiki

steps.assignmessage.SetVariableFailed 500 Kebijakan tidak dapat menyetel variabel. Lihat string fault untuk mengetahui nama variabel yang belum terselesaikan.

Kode error	Status HTTP	Penyebab
`steps.assignmessage.SetVariableFailed`	500	Kebijakan tidak dapat menyetel variabel. Lihat string fault untuk mengetahui nama variabel yang belum terselesaikan.
`steps.assignmessage.VariableOfNonMsgType`	500	Error ini terjadi jika atribut `source` dalam elemen `<Copy>` disetel ke variabel yang bukan merupakan jenis message. Variabel jenis pesan mewakili seluruh permintaan dan respons HTTP. Edge bawaan variabel alur `request`, `response`, dan `message` adalah jenis pesan. Untuk mempelajari lebih lanjut tentang variabel pesan, lihat Referensi variabel.
`steps.assignmessage.UnresolvedVariable`	500	Error ini terjadi jika variabel yang ditentukan dalam kebijakan Tetapkan Pesan: di luar cakupan (tidak tersedia di alur tertentu tempat kebijakan dijalankan) atau tidak dapat diselesaikan (tidak ditentukan)

steps.assignmessage.VariableOfNonMsgType

500

Error ini terjadi jika atribut source dalam elemen <Copy> disetel ke variabel yang bukan merupakan jenis message.

Variabel jenis pesan mewakili seluruh permintaan dan respons HTTP. Edge bawaan variabel alur request, response, dan message adalah jenis pesan. Untuk mempelajari lebih lanjut tentang variabel pesan, lihat Referensi variabel.

steps.assignmessage.UnresolvedVariable

500

Error ini terjadi jika variabel yang ditentukan dalam kebijakan Tetapkan Pesan:

di luar cakupan (tidak tersedia di alur tertentu tempat kebijakan dijalankan)
tidak dapat diselesaikan (tidak ditentukan)

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaiki
`InvalidIndex`	Jika indeks ditentukan dalam elemen `<Copy>` dan/atau `<Remove>` dari Tugaskan Pesan kebijakannya adalah 0 atau angka negatif, maka deployment Proxy API akan gagal.
`InvalidVariableName`	Jika elemen turunan `<Name>` kosong atau tidak ditentukan dalam elemen `<AssignVariable>`, deployment proxy API akan gagal karena tidak ada nama variabel valid untuk yang harus diberi nilai. Nama variabel yang valid wajib diisi.
`InvalidPayload`	Payload yang ditentukan dalam kebijakan tidak valid.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Apa yang yang perlu diketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "UnresolvedVariable"`
`assignmessage.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`assignmessage.AM-SetResponse.failed = true`

Contoh respons error

Catatan: Untuk penanganan error, praktik terbaiknya adalah menjebak errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena bisa saja berubah.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.assignmessage.VariableOfNonMsgType"
      },
      "faultstring":"AssignMessage[AM-SetResponse]: value of variable is not of type Message"
   }
}

Contoh aturan kesalahan

    <FaultRule name="Assign Message Faults">    <Step>
        <Name>AM-CustomNonMessageTypeErrorResponse</Name>
        <Condition>(fault.name Matches "VariableOfNonMsgType") </Condition>
    </Step>
    <Step>
        <Name>AM-CustomSetVariableErrorResponse</Name>
        <Condition>(fault.name = "SetVariableFailed")</Condition>
    </Step>
    <Condition>(assignmessage.failed = true) </Condition>
</FaultRule>

Kebijakan BasicAuthentication

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.basicauthentication.InvalidBasicAuthenticationSource`	500	On a decode when the incoming Base64 encoded string does not contain a valid value or the header is malformed (e.g., does not start with "Basic").
`steps.basicauthentication.UnresolvedVariable`	500	The required source variables for the decode or encode are not present. This error can only occur if `IgnoreUnresolvedVariables` is false.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Occurs when	Fix
`UserNameRequired`	The `<User>` element must be present for the named operation.
`PasswordRequired`	The `<Password>` element must be present for the named operation.
`AssignToRequired`	The `<AssignTo>` element must be present for the named operation.
`SourceRequired`	The `<Source>` element must be present for the named operation.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "UnresolvedVariable"`
`BasicAuthentication.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`BasicAuthentication.BA-Authenticate.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

Example fault rule

<FaultRule name="Basic Authentication Faults">
    <Step>
        <Name>AM-UnresolvedVariable</Name>
        <Condition>(fault.name Matches "UnresolvedVariable") </Condition>
    </Step>
    <Step>
        <Name>AM-AuthFailedResponse</Name>
        <Condition>(fault.name = "InvalidBasicAuthenticationSource")</Condition>
    </Step>
    <Condition>(BasicAuthentication.BA-Authentication.failed = true) </Condition>
</FaultRule>

Kebijakan ConcurrentRateLimit

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Occurs when

Fault code	HTTP status	Occurs when
`policies.concurrentratelimit.ConcurrentRatelimtViolation`	503	ConcurrentRatelimit connection exceeded. Connection limit : {0} Note: The Fault code shown on the left is correct, although it contains a misspelling ("limt"). Be sure to use the code exactly as shown here when creating fault rules to trap this error.

policies.concurrentratelimit.ConcurrentRatelimtViolation

503

ConcurrentRatelimit connection exceeded. Connection limit : {0}

Note: The Fault code shown on the left is correct, although it contains a misspelling ("limt"). Be sure to use the code exactly as shown here when creating fault rules to trap this error.

Deployment errors

Error name	Occurs when
`InvalidCountValue`	ConcurrentRatelimit invalid count value specified.
`ConcurrentRatelimitStepAttachment\ NotAllowedAtProxyEndpoint`	Concurrent Ratelimit policy {0} attachment is not allowed at proxy request/response/fault paths. This policy must be placed on the Target Endpoint.
`ConcurrentRatelimitStepAttachment\ MissingAtTargetEndpoint`	Concurrent Ratelimit policy {0} attachment is missing at target request/response/fault paths. This policy must be placed in the Target Request Preflow, Target Response Postflow, and DefaultFaultRule.
`InvalidTTLForMessageTimeOut`	ConcurrentRatelimit invalid ttl value specified for message timeout. It must be a positive integer.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ConcurrentRatelimtViolation"` Note: The Error code shown in the example is correct, although it contains a misspelling ("limt"). Please be sure to use the code exactly as shown here when creating fault rules to trap this error.
`concurrentratelimit.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`concurrentratelimit.CRL-RateLimitPolicy.failed = true`

Example error response

If the rate limit is exceeded, the policy returns only an HTTP status 503 to the client.

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "ConcurrentRatelimtViolation") </Condition>
        </Step>
        <Condition>concurrentratelimit.CRL-RateLimitPolicy.failed=true</Condition>
    </FaultRule>
</FaultRules>

Kebijakan DecodeJWS

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Occurs when
`steps.jws.FailedToDecode`	401	The policy was unable to decode the JWS. The JWS is possibly corrupted.
`steps.jws.FailedToResolveVariable`	401	Occurs when the flow variable specified in the `<Source>` element of the policy does not exist.
`steps.jws.InvalidClaim`	401	For a missing claim or claim mismatch, or a missing header or header mismatch.
`steps.jws.InvalidJsonFormat`	401	Invalid JSON found in the JWS header.
`steps.jws.InvalidJws`	401	This error occurs when the JWS signature verification fails.
`steps.jws.InvalidPayload`	401	The JWS payload is invalid.
`steps.jws.InvalidSignature`	401	`<DetachedContent>` is omitted and the JWS has a detached content payload.
`steps.jws.MissingPayload`	401	The JWS payload is missing.
`steps.jws.NoAlgorithmFoundInHeader`	401	Occurs when the JWS omits the algorithm header.
`steps.jws.UnknownException`	401	An unknown exception occurred.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name Occurs when

InvalidAlgorithm The only valid values are: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

Error name	Occurs when
`InvalidAlgorithm`	The only valid values are: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.
`EmptyElementForKeyConfiguration` `FailedToResolveVariable` `InvalidConfigurationForActionAndAlgorithmFamily` `InvalidConfigurationForVerify` `InvalidEmptyElement` `InvalidFamiliesForAlgorithm` `InvalidKeyConfiguration` `InvalidNameForAdditionalClaim` `InvalidNameForAdditionalHeader` `InvalidPublicKeyId` `InvalidPublicKeyValue` `InvalidSecretInConfig` `InvalidTypeForAdditionalClaim` `InvalidTypeForAdditionalHeader` `InvalidValueForElement` `InvalidValueOfArrayAttribute` `InvalidVariableNameForSecret` `MissingConfigurationElement` `MissingElementForKeyConfiguration` `MissingNameForAdditionalClaim` `MissingNameForAdditionalHeader`	Other possible deployment errors.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

Other possible deployment errors.

Variabel error

Variabel ini ditetapkan saat error runtime terjadi. Untuk mengetahui informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Dari mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error.	`fault.name Matches "TokenExpired"`
`JWS.failed`	Semua kebijakan JWS menetapkan variabel yang sama jika terjadi kegagalan.	`jws.JWS-Policy.failed = true`

Contoh respons error

Untuk penanganan error, praktik terbaiknya adalah menjebak bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena teks tersebut dapat berubah.

Contoh aturan error

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

Kebijakan DecodeJWT

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.jwt.FailedToDecode`	401	Occurs when the policy is unable to decode the JWT. The JWT may be malformed, invalid or otherwise not decodable.
`steps.jwt.FailedToResolveVariable`	401	Occurs when the flow variable specified in the `<Source>` element of the policy does not exist.
`steps.jwt.InvalidToken`	401	Occurs when the flow variable specified in the `<Source>` element of the policy is out of scope or can't be resolved.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidEmptyElement`	Occurs when the flow variable containing the JWT to be decoded is not specified in the `<Source>` element of the policy.

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "TokenExpired"`
`JWT.failed`	Semua kebijakan JWT menetapkan variabel yang sama jika terjadi kegagalan.	`JWT.failed = true`

Contoh respons error

Kode Kesalahan Kebijakan JWT

Untuk penanganan error, praktik terbaiknya adalah menangkap bagian errorcode dari error yang dihasilkan. Jangan mengandalkan teks di faultstring, karena dapat berubah.

Contoh aturan kesalahan

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

Kebijakan ExtractVariables

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error	Status HTTP	Penyebab
`steps.extractvariables.ExecutionFailed`	500	Error ini terjadi saat: Payload input (JSON, XML) kosong. Input (JSON, XML, dll.) yang diteruskan ke kebijakan tidak valid atau salah format.
`steps.extractvariables.ImmutableVariable`	500	Variabel yang digunakan dalam kebijakan tidak dapat diubah. Kebijakan tidak dapat menyetel ini variabel.
`steps.extractvariables.InvalidJSONPath`	500	Error ini terjadi jika jalur JSON yang tidak valid digunakan dalam elemen `JSONPath` elemen lebih lanjut. Misalnya, jika payload JSON tidak memiliki objek `Name`, tetapi Anda menentukan `Name` sebagai jalur dalam kebijakan, error ini akan terjadi.
`steps.extractvariables.JsonPathParsingFailure`	500	Error ini terjadi ketika kebijakan tidak dapat mengurai jalur JSON dan mengekstrak data dari variabel flow yang ditentukan dalam elemen `Source`. Biasanya seperti ini terjadi jika variabel flow yang ditentukan dalam elemen `Source` tidak ada dalam elemen saat ini alur kerja.
`steps.extractvariables.SetVariableFailed`	500	Error ini terjadi jika kebijakan tidak dapat menetapkan nilai ke suatu variabel. Umumnya error ini terjadi jika Anda mencoba menetapkan nilai ke beberapa variabel yang namanya diawali dengan kata yang sama dalam format yang dipisahkan titik.
`steps.extractvariables.SourceMessageNotAvailable`	500	Error ini terjadi jika pesan variabel yang ditentukan dalam elemen `Source` kebijakan adalah: Di luar cakupan (tidak tersedia di alur tertentu tempat kebijakan dijalankan) atau Tidak dapat diselesaikan (tidak ditentukan)
`steps.extractvariables.UnableToCast`	500	Error ini terjadi jika kebijakan tidak dapat mentransmisikan konten yang diekstrak nilai ke suatu variabel. Biasanya ini terjadi jika Anda mencoba menetapkan nilai dari satu tipe data ke variabel jenis data lainnya.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaiki
`NothingToExtract`	Jika kebijakan tidak memiliki elemen apa pun `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload`, atau `JSONPayload`, deployment Proxy API gagal, karena tidak ada yang bisa diekstrak.
`NONEmptyPrefixMappedToEmptyURI`	Error ini terjadi jika kebijakan memiliki awalan yang ditentukan dalam Elemen `Namespace` di bawah elemen `XMLPayload`, tetapi tidak ada URI yang didefinisikan.
`DuplicatePrefix`	Error ini terjadi jika kebijakan memiliki awalan yang sama yang ditentukan lebih dari sekali dalam elemen `Namespace` di bawah elemen `XMLPayload`.
`NoXPathsToEvaluate`	Jika kebijakan tidak memiliki elemen `XPath` dalam elemen `XMLPayload`, deployment proxy API gagal dengan error ini. Jika ingin mengekstrak variabel dari Payload XML, model Elemen turunan `XPath` harus ditentukan.
`EmptyXPathExpression`	Jika kebijakan memiliki ekspresi `XPath` kosong dalam `XMLPayload` , deployment proxy API akan gagal.
`NoJSONPathsToEvaluate`	Jika kebijakan tidak memiliki elemen `JSONPath` dalam elemen `JSONPayload`, deployment proxy API gagal dengan error ini.
`EmptyJSONPathExpression`	Jika kebijakan memiliki ekspresi `XPath` kosong dalam `XMLPayload`, deployment proxy API akan gagal.
`MissingName`	Jika kebijakan tersebut tidak memiliki atribut `name` di kebijakan mana pun elemen seperti `QueryParam`, `Header`, `FormParam`, atau `Variable`, jika diperlukan, maka deployment proxy API akan gagal.
`PatternWithoutVariable`	Jika kebijakan tersebut tidak memiliki variabel yang ditentukan dalam elemen `Pattern`, maka deployment proxy API akan gagal. Elemen `Pattern` memerlukan nama variabel di mana data yang diekstrak akan disimpan.
`CannotBeConvertedToNodeset`	Jika kebijakan memiliki ekspresi `XPath` dengan jenis `Variable` didefinisikan sebagai nodeset, tetapi ekspresi tidak dapat dikonversi ke nodeset, deployment proxy API akan gagal.
`JSONPathCompilationFailed`	Kebijakan ini tidak dapat mengompilasi Jalur JSON yang ditentukan.
`InstantiationFailed`	Kebijakan tidak dapat dibuat instance-nya.
`XPathCompilationFailed`	Jika awalan atau nilai yang digunakan dalam elemen `XPath` bukan bagian dari salah satu namespace yang dideklarasikan dalam kebijakan, kemudian deployment proxy API gagal.
`InvalidPattern`	Jika definisi elemen `Pattern` tidak valid dalam elemen seperti `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload` atau `JSONPayload` dalam kebijakan tersebut, maka deployment Proxy API gagal. Elemen `Pattern` dianggap tidak valid jika tidak menyertakan variabel. Untuk informasi selengkapnya tentang pencocokan pola, lihat Tentang pencocokan dan pembuatan variabel.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Apa yang yang perlu diketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name = "SourceMessageNotAvailable"`
`extractvariables.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`extractvariables.EV-ParseJsonResponse.failed = true`

Contoh respons error

Catatan: Untuk penanganan error, praktik terbaiknya adalah menjebak errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena bisa saja berubah.

{
   "fault":{
      "detail":{
         "errorcode":"steps.extractvariables.SourceMessageNotAvailable"
      },
      "faultstring":"request message is not available for ExtractVariable: EV-ParseJsonResponse"
   }
}

Contoh aturan kesalahan

<FaultRule name="Extract Variable Faults">
    <Step>
        <Name>AM-CustomErrorMessage</Name>
        <Condition>(fault.name = "SourceMessageNotAvailable") </Condition>
    </Step>
    <Condition>(extractvariables.EM-ParseJsonResponse.failed = true) </Condition>
</FaultRule>

Kebijakan GenerateJWS

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Hal yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Terjadi saat
`steps.jws.GenerationFailed`	401	Kebijakan ini tidak dapat menghasilkan JWS.
`steps.jws.InsufficientKeyLength`	401	Untuk kunci kurang dari 32 byte untuk algoritma HS256
`steps.jws.InvalidClaim`	401	Karena klaim atau klaim tidak cocok, atau ketidakcocokan header atau header tidak ada.
`steps.jws.InvalidCurve`	401	Kurva yang ditentukan oleh kunci tidak valid untuk algoritma Kurva Eliptis.
`steps.jws.InvalidJsonFormat`	401	JSON yang tidak valid ditemukan di header JWS.
`steps.jws.InvalidPayload`	401	Payload JWS tidak valid.
`steps.jws.InvalidSignature`	401	`<DetachedContent>` dihilangkan dan JWS memiliki payload konten terpisah.
`steps.jws.KeyIdMissing`	401	Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi JWS yang ditandatangani tidak menyertakan properti `kid` di header.
`steps.jws.KeyParsingFailed`	401	Kunci publik tidak dapat diuraikan dari informasi kunci yang diberikan.
`steps.jws.MissingPayload`	401	Payload JWS tidak ada.
`steps.jws.NoAlgorithmFoundInHeader`	401	Terjadi saat JWS menghilangkan header algoritma.
`steps.jws.SigningFailed`	401	Dalam GenerateJWS, untuk kunci yang kurang dari ukuran minimum untuk algoritma HS384 atau HS512
`steps.jws.UnknownException`	401	Terjadi pengecualian yang tidak diketahui.
`steps.jws.WrongKeyType`	401	Jenis kunci yang ditentukan salah. Misalnya, jika Anda menentukan kunci RSA untuk algoritma Kurva Elliptik, atau kunci kurva untuk algoritma RSA.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error Terjadi saat

InvalidAlgorithm Satu-satunya nilai yang valid adalah: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

Nama error	Terjadi saat
`InvalidAlgorithm`	Satu-satunya nilai yang valid adalah: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.
`EmptyElementForKeyConfiguration` `FailedToResolveVariable` `InvalidConfigurationForActionAndAlgorithmFamily` `InvalidConfigurationForVerify` `InvalidEmptyElement` `InvalidFamiliesForAlgorithm` `InvalidKeyConfiguration` `InvalidNameForAdditionalClaim` `InvalidNameForAdditionalHeader` `InvalidPublicKeyId` `InvalidPublicKeyValue` `InvalidSecretInConfig` `InvalidTypeForAdditionalClaim` `InvalidTypeForAdditionalHeader` `InvalidValueForElement` `InvalidValueOfArrayAttribute` `InvalidVariableNameForSecret` `MissingConfigurationElement` `MissingElementForKeyConfiguration` `MissingNameForAdditionalClaim` `MissingNameForAdditionalHeader`	Kemungkinan error deployment lainnya.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

Kemungkinan error deployment lainnya.

Variabel error

Variabel ini ditetapkan saat error runtime terjadi. Untuk mengetahui informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Dari mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error.	`fault.name Matches "TokenExpired"`
`JWS.failed`	Semua kebijakan JWS menetapkan variabel yang sama jika terjadi kegagalan.	`jws.JWS-Policy.failed = true`

Contoh respons error

Untuk penanganan error, praktik terbaiknya adalah menjebak bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena teks tersebut dapat berubah.

Contoh aturan error

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

Kebijakan GenerateJWT

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Terjadi saat
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	Terjadi saat kebijakan verifikasi memiliki beberapa algoritma.
`steps.jwt.AlgorithmMismatch`	401	Algoritme yang ditentukan dalam kebijakan Buat tidak cocok dengan yang diharapkan dalam kebijakan Verifikasi. Algoritma yang ditentukan harus cocok.
`steps.jwt.FailedToDecode`	401	Kebijakan tidak dapat mendekode JWT. JWT mungkin rusak.
`steps.jwt.GenerationFailed`	401	Kebijakan tidak dapat menghasilkan JWT.
`steps.jwt.InsufficientKeyLength`	401	Untuk kunci yang berukuran kurang dari 32 byte untuk algoritma HS256, kurang dari 48 byte untuk algoritma HS386, dan kurang dari 64 byte untuk algoritma HS512.
`steps.jwt.InvalidClaim`	401	Karena klaim atau klaim tidak cocok, atau ketidakcocokan header atau header tidak ada.
`steps.jwt.InvalidCurve`	401	Kurva yang ditentukan oleh kunci tidak valid untuk algoritma Kurva Eliptis.
`steps.jwt.InvalidJsonFormat`	401	JSON yang tidak valid ditemukan di header atau payload.
`steps.jwt.InvalidToken`	401	Error ini terjadi saat verifikasi tanda tangan JWT gagal.
`steps.jwt.JwtAudienceMismatch`	401	Klaim audiens gagal pada verifikasi token.
`steps.jwt.JwtIssuerMismatch`	401	Klaim penerbit gagal pada verifikasi token.
`steps.jwt.JwtSubjectMismatch`	401	Klaim subjek gagal pada verifikasi token.
`steps.jwt.KeyIdMissing`	401	Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi JWT yang ditandatangani tidak menyertakan properti `kid` di header.
`steps.jwt.KeyParsingFailed`	401	Kunci publik tidak dapat diuraikan dari informasi kunci yang diberikan.
`steps.jwt.NoAlgorithmFoundInHeader`	401	Terjadi saat JWT tidak berisi header algoritma.
`steps.jwt.NoMatchingPublicKey`	401	Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi `kid` dalam JWT yang ditandatangani tidak tercantum di JWKS.
`steps.jwt.SigningFailed`	401	Dalam GenerateJWT, untuk kunci yang kurang dari ukuran minimum untuk algoritma HS384 atau HS512
`steps.jwt.TokenExpired`	401	Kebijakan ini akan mencoba memverifikasi token yang sudah habis masa berlakunya.
`steps.jwt.TokenNotYetValid`	401	Token belum valid.
`steps.jwt.UnhandledCriticalHeader`	401	Header yang ditemukan oleh kebijakan Verifikasi JWT di header `crit` tidak tercantum di `KnownHeaders`.
`steps.jwt.UnknownException`	401	Terjadi pengecualian yang tidak diketahui.
`steps.jwt.WrongKeyType`	401	Jenis kunci yang ditentukan salah. Misalnya, jika Anda menentukan kunci RSA untuk algoritma Kurva Elliptik, atau kunci kurva untuk algoritma RSA.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaiki
`InvalidNameForAdditionalClaim`	Deployment akan gagal jika klaim yang digunakan dalam elemen turunan `<Claim>` dari elemen `<AdditionalClaims>` adalah salah satu nama yang terdaftar berikut: `kid`, `iss`, `sub`, `aud`, `iat`, `exp`, `nbf`, atau `jti`.
`InvalidTypeForAdditionalClaim`	Jika klaim yang digunakan dalam elemen turunan `<Claim>` elemen `<AdditionalClaims>` bukan jenis `string`, `number`, `boolean`, atau `map`, deployment akan gagal.
`MissingNameForAdditionalClaim`	Jika nama klaim tidak ditentukan dalam elemen turunan `<Claim>` dari elemen `<AdditionalClaims>`, deployment akan gagal.
`InvalidNameForAdditionalHeader`	Error ini terjadi jika nama klaim yang digunakan dalam elemen turunan `<Claim>` dari elemen `<AdditionalClaims>` adalah `alg` atau `typ`.
`InvalidTypeForAdditionalHeader`	Jika jenis klaim yang digunakan dalam elemen turunan `<Claim>` dari elemen `<AdditionalClaims>` bukan jenis `string`, `number`, `boolean`, atau `map`, deployment akan gagal.
`InvalidValueOfArrayAttribute`	Error ini terjadi jika nilai atribut array dalam elemen turunan `<Claim>` dari elemen `<AdditionalClaims>` tidak ditetapkan ke `true` atau `false`.
`InvalidConfigurationForActionAndAlgorithm`	Jika elemen `<PrivateKey>` digunakan dengan algoritma Keluarga HS atau elemen `<SecretKey>` digunakan dengan algoritma Keluarga RSA, deployment akan gagal.
`InvalidValueForElement`	Jika nilai yang ditentukan dalam elemen `<Algorithm>` bukan nilai yang didukung, deployment akan gagal.
`MissingConfigurationElement`	Error ini akan terjadi jika elemen `<PrivateKey>` tidak digunakan dengan algoritma kelompok RSA atau elemen `<SecretKey>` tidak digunakan dengan algoritma Keluarga HS.
`InvalidKeyConfiguration`	Jika elemen turunan `<Value>` tidak ditetapkan dalam elemen `<PrivateKey>` atau `<SecretKey>`, deployment akan gagal.
`EmptyElementForKeyConfiguration`	Jika atribut referensi elemen turunan `<Value>` dari elemen `<PrivateKey>` atau `<SecretKey>` kosong atau tidak ditentukan, deployment akan gagal.
`InvalidVariableNameForSecret`	Error ini terjadi jika nama variabel flow yang ditentukan dalam atribut ref elemen turunan `<Value>` dari elemen `<PrivateKey>` atau `<SecretKey>` tidak berisi awalan pribadi `(private.)`.
`InvalidSecretInConfig`	Error ini terjadi jika elemen turunan `<Value>` dari elemen `<PrivateKey>` atau `<SecretKey>` tidak berisi awalan pribadi `(private.)`.
`InvalidTimeFormat`	Jika nilai yang ditentukan dalam elemen `<NotBefore>` tidak menggunakan format yang didukung, deployment akan gagal.

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "TokenExpired"`
`JWT.failed`	Semua kebijakan JWT menetapkan variabel yang sama jika terjadi kegagalan.	`JWT.failed = true`

Contoh respons error

Kode Kesalahan Kebijakan JWT

Untuk penanganan error, praktik terbaiknya adalah menangkap bagian errorcode dari error yang dihasilkan. Jangan mengandalkan teks di faultstring, karena dapat berubah.

Contoh aturan kesalahan

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

Kebijakan JavaCallout

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error	Status HTTP	Penyebab	Perbaiki
`steps.javacallout.ExecutionError`	500	Terjadi saat kode Java menampilkan pengecualian atau menampilkan null selama eksekusi kebijakan Javacallout.

Error saat deployment

Error ini dapat terjadi saat proxy yang berisi kebijakan di-deploy.

Nama error	String kesalahan	Status HTTP	Terjadi saat
`ResourceDoesNotExist`	`Resource with name [name] and type [type] does not exist`	T/A	File yang ditentukan dalam elemen `<ResourceURL>` tidak ada.
`JavaCalloutInstantiationFailed`	`Failed to instantiate the JavaCallout Class [classname]`	T/A	File class yang ditetapkan dalam elemen `<ClassName>` tidak ada dalam stoples.
`IncompatibleJavaVersion`	`Failed to load java class [classname] definition due to - [reason]`	T/A	Lihat string kesalahan. Lihat juga Didukung software dan versi yang didukung.
`JavaClassNotFoundInJavaResource`	`Failed to find the ClassName in java resource [jar_name] - [class_name]`	T/A	Lihat string kesalahan.
`JavaClassDefinitionNotFound`	`Failed to load java class [class_name] definition due to - [reason]`	T/A	Lihat string kesalahan.
`NoAppropriateConstructor`	`No appropriate constructor found in JavaCallout class [class_name]`	T/A	Lihat string kesalahan.
`NoResourceForURL`	`Could not locate a resource with URL [string]`	T/A	Lihat string kesalahan.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "ExecutionError"`
`javacallout.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`javacallout.JC-GetUserData.failed = true`

Contoh respons error

{  
   "fault":{  
      "faultstring":"Failed to execute JavaCallout. [policy_name]",
      "detail":{  
         "errorcode":"javacallout.ExecutionError"
      }
   }
}

Contoh aturan kesalahan

<FaultRule name="JavaCalloutFailed">
    <Step>
        <Name>AM-JavaCalloutError</Name>
    </Step>
    <Condition>(fault.name Matches "ExecutionError") </Condition>
</FaultRule>

Kebijakan JavaScript

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.javascript.ScriptExecutionFailed`	500	The JavaScript policy can throw many different types of ScriptExecutionFailed errors. Commonly seen types of errors include RangeError, ReferenceError, SyntaxError, TypeError, and URIError.
`steps.javascript.ScriptExecutionFailedLineNumber`	500	An error occurred in the JavaScript code. See the fault string for details.	N/A
`steps.javascript.ScriptSecurityError`	500	A security error occurred when the JavaScript executed. See the fault string for details.	N/A

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidResourceUrlFormat`	If the format of the resource URL specified within the `<ResourceURL>` or the `<IncludeURL>` element of the JavaScript policy is invalid, then the deployment of the API proxy fails.
`InvalidResourceUrlReference`	If the `<ResourceURL>` or the `<IncludeURL>` elements refer to a JavaScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.
`WrongResourceType`	This error occurs during deployment if the `<ResourceURL>` or the `<IncludeURL>` elements of the JavaScript policy refer to any resource type other than jsc (JavaScript file).
`NoResourceURLOrSource`	The deployment of the JavaScript policy can fail with this error if the `<ResourceURL>` element is not declared or if the resource URL is not defined within this element. `<ResourceURL>` element is a mandatory element. Or, The `<IncludeURL>` element is declared but the resource URL is not defined within this element. The `<IncludeURL>` element is optional but if declared, the resource URL must be specified within the `<IncludeURL>` element.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ScriptExecutionFailed"`
`javascript.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`javascript.JavaScript-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="JavaScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(javascript.JavaScript-1.failed = true) </Condition>
</FaultRule>

Kebijakan JSONThreatProtection

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.jsonthreatprotection.ExecutionFailed`	500	The JSONThreatProtection policy can throw many different types of ExecutionFailed errors. Most of these errors occur when a specific threshold set in the policy is exceeded. These types of errors include: object entry name length, object entry count, array element count, container depth, string string value length. This error also occurs when the payload contains an invalid JSON object.
`steps.jsonthreatprotection.SourceUnavailable`	500	This error occurs if the message variable specified in the `<Source>` element is either: Out of scope (not available in the specific flow where the policy is being executed) Is not one of the valid values `request`, `response`, or `message`
`steps.jsonthreatprotection.NonMessageVariable`	500	This error occurs if the `<Source>` element is set to a variable which is not of type message.

Deployment errors

None.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "SourceUnavailable"`
`jsonattack.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`jsonattack.JTP-SecureRequest.failed = true`

Example error response

{
  "fault": {
    "faultstring": "JSONThreatProtection[JPT-SecureRequest]: Execution failed. reason: JSONThreatProtection[JTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.jsonthreatprotection.ExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="JSONThreatProtection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(jsonattack.JPT-SecureRequest.failed = true) </Condition>
</FaultRule>

Jenis kebijakan JSONThreatProtection menentukan kode error berikut:

Kebijakan JSONtoXML

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error	Status HTTP	Penyebab
`steps.jsontoxml.ExecutionFailed`	500	Payload input (JSON) kosong atau input (JSON) yang diteruskan ke kebijakan JSON ke XML tidak valid atau salah format.
`steps.jsontoxml.InCompatibleTypes`	500	Error ini terjadi jika jenis variabel yang ditentukan dalam elemen `<Source>` dan elemen `<OutputVariable>` tidak sama. Jenis atribut harus variabel yang ada dalam elemen `<Source>` dan elemen `<OutputVariable>` yang cocok. Jenis yang valid adalah `message` dan `string`.
`steps.jsontoxml.InvalidSourceType`	500	Error ini terjadi jika jenis variabel yang digunakan untuk menentukan elemen `<Source>` tidak valid. Jenis variabel yang valid adalah `message` dan `string`.
`steps.jsontoxml.OutputVariableIsNotAvailable`	500	Error ini terjadi jika variabel yang ditentukan dalam elemen `<Source>` dari JSON untuk Kebijakan XML memiliki jenis string dan elemen `<OutputVariable>` tidak ditentukan. Elemen `<OutputVariable>` bersifat wajib jika variabel ditentukan dalam `<Source>` adalah dari tipe string.
`steps.jsontoxml.SourceUnavailable`	500	Error ini terjadi jika pesan variabel yang ditentukan dalam elemen `<Source>` pada kebijakan JSON ke XML adalah: di luar cakupan (tidak tersedia dalam alur spesifik tempat kebijakan dijalankan) atau tidak dapat diselesaikan (tidak ditentukan)

Error saat deployment

Tidak ada.

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "SourceUnavailable"`
`jsontoxml.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`jsontoxml.JSON-to-XML-1.failed = true`

Contoh respons error

Catatan: Untuk penanganan error, praktik terbaiknya adalah menjebak errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena bisa saja berubah.

{
  "fault": {
    "faultstring": "JSONToXML[JSON-to-XML-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.json2xml.SourceUnavailable"
    }
  }
}

Contoh aturan kesalahan

<FaultRule name="JSON To XML Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadJSON</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(jsontoxml.JSON-to-XML-1.failed = true) </Condition>
</FaultRule>

Kebijakan KeyValueMapOperations

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.keyvaluemapoperations.SetVariableFailed`	500	This error occurs if you try to retrieve a value from an encrypted key value map and set the value to a variable whose name does not have the prefix `private`. The prefix, which is required for basic security purposes during debugging, hides the encrypted values from API proxy Trace and debug sessions.
`steps.keyvaluemapoperations.UnsupportedOperationException`	500	This error occurs if the `mapIdentifier` attribute is set to empty string in the Key Value Map Operations policy.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidIndex`	If the `index` attribute specified in the `<Get>` element of Key Value Map Operations policy is zero or a negative number, then the deployment of the API proxy fails. The index starts from `1`, so an index of zero or negative integer is considered as invalid.
`KeyIsMissing`	This error occurs if the `<Key>` element is completely missing or `<Parameter>` element is missing within `<Key>` element underneath the `<Entry>` of the `<InitialEntries>` element of the Key Value Map Operations policy.
`ValueIsMissing`	This error occurs if the `<Value>` element is missing underneath the `<Entry>` element of the `<InitialEntries>` element of the Key Value Map Operations policy.

Kebijakan LDAP

Kebijakan ini menggunakan kode error berikut:

Kode Error	Pesan
`InvalidAttributeName`	`Invalid attribute name {0}.`
`InvalidSearchBase`	`Search base can not be empty.`
`InvalidValueForPassword`	`Invalid value for password field. It can not be empty.`
`InvalidSearchScope`	`Invalid scope {0}. Allowed scopes are {1}.`
`InvalidUserCredentials`	`Invalid user credentials.`
`InvalidExternalLdapReference`	`Invalid external ldap reference {0}.`
`LdapResourceNotFound`	`Ldap resource {0} not found.`
`BaseDNRequired`	`Base DN required.`
`OnlyReferenceOrValueIsAllowed`	`Only value or reference is allowed for {0}.`
`AttributesRequired`	`At least one attribute required for search action.`
`UserNameIsNull`	`User name is null.`
`SearchQueryAndUserNameCannotBePresent`	`Both search query and username can not be present in the authentication action. Please specify either one of them.`

Kebijakan MessageLogging

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.messagelogging.StepDefinitionExecutionFailed`	500	See fault string.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidProtocol`	The deployment of the MessageLogging policy can fail with this error if the protocol specified within the `<Protocol>` element is not valid. The valid protocols are TCP and UDP. For sending syslog messages over TLS/SSL, only TCP is supported.
`InvalidPort`	The deployment of the MessageLogging policy can fail with this error if the port number is not specified within the `<Port>` element or if it is not valid. The port number must be an integer greater than zero.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "StepDefinitionExecutionFailed"`
`messagelogging.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`messagelogging.ML-LogMessages.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Example fault rule

<FaultRule name="MessageLogging">
    <Step>
        <Name>ML-LogMessages</Name>
        <Condition>(fault.name Matches "StepDefinitionExecutionFailed") </Condition>
    </Step>
    <Condition>(messagelogging.ML-LogMessages.failed = true) </Condition>
</FaultRule>

Kebijakan OASValidation

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Penyebab
`steps.oasvalidation.Failed`	500	Isi pesan permintaan tidak dapat divalidasi berdasarkan Spesifikasi OpenAPI yang diberikan.
`steps.oasvalidation.SourceMessageNotAvailable`	500	Variabel yang ditentukan dalam elemen `<Source>` kebijakan berada di luar cakupan atau tidak dapat diselesaikan.
`steps.oasvalidation.NotMessageVariable`	500	Elemen `<Source>` ditetapkan ke variabel yang bukan jenis message.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab
`ResourceDoesNotExist`	Spesifikasi OpenAPI yang dirujuk dalam elemen `<OASResource>` tidak ada.
`ResourceCompileFailed`	Spesifikasi OpenAPI yang disertakan dalam deployment berisi error yang mencegahnya dikompilasi. Hal ini secara umum menunjukkan bahwa spesifikasi tersebut bukan Spesifikasi OpenAPI 3.0 yang diformat dengan baik.
`BadResourceURL`	Spesifikasi OpenAPI yang direferensikan dalam elemen `<OASResource>` tidak dapat diproses. Hal ini dapat terjadi jika file bukan file JSON atau YAML, atau URL file tidak ditentukan dengan benar.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Dari mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "ResourceDoesNotExist"`
`oasvalidation.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`oasvalidation.myoaspolicy.failed = true`

Kebijakan PopulateCache

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error	Status HTTP	Terjadi saat
`policies.populatecache.EntryCannotBeCached`	500	Entri tidak dapat di-cache. Objek pesan yang di-cache bukan merupakan instance yang dapat diserialisasi.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaiki
`InvalidCacheResourceReference`	Error ini terjadi jika elemen `<CacheResource>` dalam kebijakan Mengisi Cache ditetapkan ke nama yang tidak ada di lingkungan tempat proxy API di-deploy.
`CacheNotFound`	Cache yang ditentukan dalam elemen `<CacheResource>` tidak ada.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name = "EntryCannotBeCached"`
`populatecache.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`populatecache.POP-CACHE-1.failed = true`

Contoh respons error

{
  "fault": {
    "faultstring": "[entry] can not be cached. Only serializable entries are cached.",
    "detail": {
      "errorcode": "steps.populatecache.EntryCannotBeCached"
    }
  }
}

Contoh aturan kesalahan

<FaultRule name="Populate Cache Fault">
    <Step>
        <Name>AM-EntryCannotBeCached</Name>
        <Condition>(fault.name Matches "EntryCannotBeCached") </Condition>
    </Step>
    <Condition>(populatecache.POP-CACHE-1.failed = true) </Condition>
</FaultRule>

Kebijakan LookupCache

Bagian ini menjelaskan pesan error dan variabel alur yang ditetapkan saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda sedang mengembangkan aturan fault untuk proxy. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Awalan kode error

T/A

Error runtime

Kebijakan ini tidak menampilkan error runtime apa pun.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaiki
`InvalidCacheResourceReference`	Error ini terjadi jika elemen `<CacheResource>` disetel ke nama yang tidak ada di lingkungan tempat proxy API di-deploy.
`InvalidTimeout`	Jika elemen `<CacheLookupTimeoutInSeconds>` disetel ke angka negatif, deployment proxy API akan gagal.
`CacheNotFound`	Error ini terjadi jika cache tertentu yang disebutkan dalam pesan error tidak dibuat pada komponen Pemroses Pesan tertentu.

Variabel kesalahan

T/A

Contoh respons error

T/A

Kebijakan InvalidateCache

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults.

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidCacheResourceReference`	This error occurs if the `<CacheResource>` element in the InvalidateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
`CacheNotFound`	This error occurs if the specific cache mentioned in the error message has not been created on a specific Message Processor component.

Fault variables

N/A

Example error response

N/A

Kebijakan ResponseCache

Awalan kode error

T/A

Error runtime

Kebijakan ini tidak menampilkan error runtime apa pun.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaiki
`InvalidTimeout`	Jika elemen `<CacheLookupTimeoutInSeconds>` kebijakan ResponseCache ditetapkan ke angka negatif, deployment proxy API akan gagal.
`InvalidCacheResourceReference`	Error ini terjadi jika elemen `<CacheResource>` dalam kebijakan ResponseCache ditetapkan ke nama yang tidak ada di lingkungan tempat proxy API di-deploy.
`ResponseCacheStepAttachmentNotAllowedReq`	Error ini terjadi jika kebijakan ResponseCache yang sama dilampirkan ke beberapa jalur permintaan dalam setiap alur proxy API.
`ResponseCacheStepAttachmentNotAllowedResp`	Error ini terjadi jika kebijakan ResponseCache yang sama dilampirkan ke beberapa jalur respons dalam setiap alur proxy API.
`InvalidMessagePatternForErrorCode`	Error ini terjadi jika elemen `<SkipCacheLookup>` atau `<SkipCachePopulation>` dalam kebijakan ResponseCache berisi kondisi yang tidak valid.
`CacheNotFound`	Error ini terjadi jika cache tertentu yang disebutkan dalam pesan error tidak dibuat pada komponen Pemroses Pesan tertentu.

Variabel kesalahan

T/A

Contoh respons error

T/A

Kebijakan OAuthV2

Bagian ini menjelaskan kode error dan pesan error yang ditampilkan serta variabel error yang ditetapkan oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kerusakan	Status HTTP	Penyebab	Ditampilkan oleh operasi
`steps.oauth.v2.access_token_expired`	401	Masa berlaku token akses telah berakhir.	VerifyAccessToken InvalidateToken
`steps.oauth.v2.access_token_not_approved`	401	Token akses telah dicabut.	VerifyAccessToken
`steps.oauth.v2.apiresource_doesnot_exist`	401	Resource yang diminta tidak ada produk API yang terkait dengan token akses.	VerifyAccessToken
`steps.oauth.v2.FailedToResolveAccessToken`	500	Kebijakan diharapkan menemukan token akses dalam variabel yang ditentukan dalam elemen `<AccessToken>`, tetapi variabel tersebut tidak dapat di-resolve.	GenerateAccessToken
`steps.oauth.v2.FailedToResolveAuthorizationCode`	500	Kebijakan diharapkan menemukan kode otorisasi dalam variabel yang ditentukan dalam elemen `<Code>`, tetapi variabel tersebut tidak dapat di-resolve.	GenerateAuthorizationCode
`steps.oauth.v2.FailedToResolveClientId`	500	Kebijakan diharapkan menemukan Client ID dalam variabel yang ditentukan dalam elemen `<ClientId>`, tetapi variabel tersebut tidak dapat di-resolve.	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken
`steps.oauth.v2.FailedToResolveRefreshToken`	500	Kebijakan diharapkan menemukan token refresh dalam variabel yang ditentukan dalam elemen `<RefreshToken>`, tetapi variabel tersebut tidak dapat di-resolve.	RefreshAccessToken
`steps.oauth.v2.FailedToResolveToken`	500	Kebijakan diharapkan menemukan token dalam variabel yang ditentukan dalam elemen `<Tokens>`, tetapi variabel tidak dapat di-resolve.	ValidateToken InvalidateToken
`steps.oauth.v2.InsufficientScope`	403	Token akses yang ditampilkan dalam permintaan memiliki cakupan yang tidak cocok dengan cakupan yang ditentukan dalam kebijakan token akses verifikasi. Untuk mempelajari cakupan, lihat Menggunakan cakupan OAuth2.	VerifyAccessToken
`steps.oauth.v2.invalid_access_token`	401	Token akses yang dikirim dari klien tidak valid.	VerifyAccessToken
`steps.oauth.v2.invalid_client`	401	Nama error ini ditampilkan saat properti `<GenerateResponse>` kebijakan ditetapkan ke true dan client ID yang dikirim dalam permintaan tidak valid. Periksa untuk memastikan Anda menggunakan kunci klien dan nilai rahasia yang benar untuk Aplikasi Developer yang terkait dengan proxy Anda. Biasanya, nilai ini dikirim sebagai header Basic Authorization yang dienkode Base64. Catatan: Sebaiknya ubah kondisi aturan error yang ada untuk menangkap nama `invalid_client` dan `InvalidClientIdentifier`. Lihat Catatan Rilis 16.09.21 untuk mengetahui informasi selengkapnya dan contohnya.	GenerateAccessToken RefreshAccessToken
`steps.oauth.v2.InvalidRequest`	400	Nama error ini digunakan untuk beberapa jenis error, biasanya untuk parameter yang tidak ada atau salah yang dikirim dalam permintaan. Jika `<GenerateResponse>` ditetapkan ke `false`, gunakan variabel error (dijelaskan di bawah) untuk mengambil detail tentang error, seperti nama dan penyebab error.	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken
`steps.oauth.v2.InvalidAccessToken`	401	Header otorisasi tidak memiliki kata "Bearer", yang diperlukan. Misalnya: `Authorization: Bearer your_access_token`	VerifyAccessToken
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Proxy API tidak ada dalam Produk yang terkait dengan token akses. Tips: Pastikan produk yang terkait dengan token akses dikonfigurasi dengan benar. Misalnya, jika Anda menggunakan karakter pengganti di jalur resource, pastikan karakter pengganti digunakan dengan benar. Lihat Membuat produk API untuk mengetahui detailnya. Lihat juga postingan Komunitas Apigee ini untuk mendapatkan panduan selengkapnya tentang penyebab error ini.	VerifyAccessToken
`steps.oauth.v2.InvalidClientIdentifier`	500	Nama error ini ditampilkan saat properti `<GenerateResponse>` kebijakan ditetapkan ke false dan client ID yang dikirim dalam permintaan tidak valid. Periksa untuk memastikan Anda menggunakan kunci klien dan nilai rahasia yang benar untuk Aplikasi Developer yang terkait dengan proxy Anda. Biasanya, nilai ini dikirim sebagai header Basic Authorization berenkode Base64. Catatan: Dalam situasi ini, error ini sebelumnya disebut `invalid_client`. Sebaiknya ubah kondisi aturan error yang ada untuk menangkap nama `invalid_client` dan `InvalidClientIdentifier`. Lihat Catatan Rilis 16.09.21 untuk mengetahui informasi selengkapnya dan contohnya.	GenerateAccessToken RefreshAccessToken
`steps.oauth.v2.InvalidParameter`	500	Kebijakan harus menentukan token akses atau kode otorisasi, tetapi tidak keduanya.	GenerateAuthorizationCode GenerateAccessTokenImplicitGrant
`steps.oauth.v2.InvalidTokenType`	500	Elemen `<Tokens>/<Token>` mengharuskan Anda menentukan jenis token (misalnya, `refreshtoken`). Jika klien meneruskan jenis yang salah, error ini akan ditampilkan.	ValidateToken InvalidateToken
`steps.oauth.v2.MissingParameter`	500	Jenis respons adalah `token`, tetapi tidak ada jenis pemberian yang ditentukan.	GenerateAuthorizationCode GenerateAccessTokenImplicitGrant
`steps.oauth.v2.UnSupportedGrantType`	500	Klien menentukan jenis pemberian yang tidak didukung oleh kebijakan (tidak tercantum dalam elemen <SupportedGrantTypes>). Catatan: Saat ini ada bug saat error jenis pemberian yang tidak didukung tidak ditampilkan dengan benar. Jika terjadi error jenis pemberian yang tidak didukung, proxy tidak memasuki Alur Error, seperti yang diharapkan.	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab
`InvalidValueForExpiresIn`	Untuk elemen `<ExpiresIn>`, nilai yang valid adalah bilangan bulat positif dan `-1`.
`InvalidValueForRefreshTokenExpiresIn`	Untuk elemen `<RefreshTokenExpiresIn>`, nilai yang valid adalah bilangan bulat positif dan `-1`.
`InvalidGrantType`	Jenis pemberian yang tidak valid ditentukan di elemen `<SupportedGrantTypes>`. Lihat referensi kebijakan untuk mengetahui daftar jenis yang valid.
`ExpiresInNotApplicableForOperation`	Pastikan operasi yang ditentukan dalam elemen <Operations> mendukung masa berlaku. Misalnya, operasi VerifyToken tidak melakukannya.
`RefreshTokenExpiresInNotApplicableForOperation`	Pastikan operasi yang ditentukan dalam elemen <Operations> mendukung masa berlaku token refresh. Misalnya, operasi VerifyToken tidak melakukannya.
`GrantTypesNotApplicableForOperation`	Pastikan jenis pemberian yang ditentukan dalam <SupportedGrantTypes> didukung untuk operasi yang ditentukan.
`OperationRequired`	Anda harus menentukan operasi dalam kebijakan ini menggunakan elemen `<Operation>`. Catatan: Jika elemen `<Operation>` tidak ada, UI akan menampilkan error validasi skema.
`InvalidOperation`	Anda harus menentukan operasi yang valid dalam kebijakan ini menggunakan elemen `<Operation>`. Catatan: Jika elemen `<Operation>` tidak valid, UI akan menampilkan error validasi skema.
`TokenValueRequired`	Anda harus menentukan nilai `<Token>` token dalam elemen `<Tokens>`.

Variabel error

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime.

Catatan: Anda dapat menggunakan variabel ini untuk membuat kondisi Aturan Error. Variabel ini diisi saat error terjadi jika <GenerateResponse> ditetapkan ke false. Jika <GenerateResponse> adalah true, kebijakan akan segera menampilkan respons kepada klien jika terjadi error -- alur error akan dilewati dan variabel ini tidak diisi. Untuk mengetahui informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error.	`fault.name = "InvalidRequest"`
`oauthV2.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan error.	`oauthV2.GenerateAccesstoken.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan error.	`oauthV2.GenerateAccesstoken.fault.name = InvalidRequest` Catatan: Untuk operasi VerifyAccessToken, nama error menyertakan akhiran ini: `keymanagement.service` Misalnya: `keymanagement.service.invalid_access_token`
`oauthV2.policy_name.fault.cause`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan error.	`oauthV2.GenerateAccesstoken.cause = Required param : grant_type`

Contoh respons error

Respons ini dikirim kembali ke klien jika elemen <GenerateResponse> bernilai true.

Catatan: Untuk penanganan error, praktik terbaiknya adalah menangkap bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena teks tersebut dapat berubah.

Jika <GenerateResponse> true, kebijakan akan menampilkan error dalam format ini untuk operasi yang menghasilkan token dan kode. Untuk mengetahui daftar lengkapnya, lihat Referensi respons error HTTP OAuth.

{"ErrorCode" : "invalid_client", "Error" :"ClientId is Invalid"}

Jika <GenerateResponse> bernilai true, kebijakan akan menampilkan error dalam format ini untuk operasi verifikasi dan validasi. Untuk mengetahui daftar lengkapnya, lihat referensi respons error HTTP OAuth.

{  
   {  
      "fault":{  
         "faultstring":"Invalid Access Token",
         "detail":{  
            "errorcode":"keymanagement.service.invalid_access_token"
         }
      }
   }

Contoh aturan error

<FaultRule name=OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientResponse</Name>
        <Condition>(fault.name = "invalid_client") OR (fault.name = "InvalidClientIdentifier")</Condition>
    </Step>
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Kebijakan GetOAuthV2Info

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan. Nama-nama {i>error<i} yang ditunjukkan di bawah ini adalah {i>string<i} yang ditetapkan ke variabel fault.name saat terjadi error. Lihat Kesalahan variabel di bawah ini untuk detail lebih lanjut.

Kode error	Status HTTP	Penyebab
`steps.oauth.v2.access_token_expired`	500	Masa berlaku token akses yang dikirim ke kebijakan sudah berakhir.
`steps.oauth.v2.authorization_code_expired`	500	Kode otorisasi yang dikirim ke kebijakan sudah tidak berlaku.
`steps.oauth.v2.invalid_access_token`	500	Token akses yang dikirim ke kebijakan tidak valid.
`steps.oauth.v2.invalid_client-invalid_client_id`	500	Client ID yang dikirim ke kebijakan tidak valid.
`steps.oauth.v2.invalid_refresh_token`	500	Token refresh yang dikirim ke kebijakan tidak valid.
`steps.oauth.v2.invalid_request-authorization_code_invalid`	500	Kode otorisasi yang dikirim ke kebijakan tidak valid.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Harap lihat postingan Komunitas Apigee ini untuk mendapatkan informasi tentang pemecahan masalah error ini.
`steps.oauth.v2.refresh_token_expired`	500	Masa berlaku token refresh yang dikirim ke kebijakan sudah berakhir.

Error saat deployment

Lihat pesan yang dilaporkan di UI untuk mengetahui informasi tentang error deployment.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error saat runtime.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "IPDeniedAccess"`
`oauthV2.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`oauthV2.GetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`oauthV2.GetToKenInfo.fault.name = invalid_client-invalid_client_id`
`oauthV2.policy_name.fault.cause`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`oauthV2.GetTokenInfo.cause = ClientID is Invalid`

Contoh respons error

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

Contoh aturan kesalahan

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

Kebijakan SetOAuthV2Info

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.oauth.v2.access_token_expired`	500	The access token sent to the policy is expired.
`steps.oauth.v2.invalid_access_token`	500	The access token sent to the policy is invalid.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Please see this Apigee Community post for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.SetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.SetTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.SetTokenInfo.cause = Invalid Access Token`

Example error response

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Kebijakan DeleteOAuthV2Info

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.oauth.v2.invalid_access_token`	401	The access token sent to the policy is invalid.
`steps.oauth.v2.invalid_request-authorization_code_invalid`	401	The authorization code sent to the policy is invalid.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Please see this Apigee Community post for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.DeleteTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.DeleteTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.DeleteTokenInfo.cause = Invalid Access Token`

Example error response

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

Kebijakan OAuthv1.0a

The OAuthV1 Policy type defines the following error codes.

For OAuth-related HTTP error codes, see OAuth HTTP error response reference.

Error Code	Message

`AppKeyNotResolved`	`Could not resolve the app key with variable {0}`
`ConsumerKeyNotResolved`	`Could not resolve the consumer key with variable {0}`
`RequestTokenNotResolved`	`Could not resolve the request token with the variable {0}`
`AccessTokenNotResolved`	`Could not resolve the access token with the variable {0}`
`ResponseGenerationError`	`Error while generating response : {0}`
`UnableToDetermineOperation`	`Unable to determine an operation for stepDefinition {0}`
`UnableToResolveOAuthConfig`	`Unable to resolve the OAuth configuration for {0}`
`AtLeastOneParamRequired`	`At least one of AccessToken, RequestToken or ConsumerKey must be specified in stepDefinition {0}`
`SpecifyValueOrRefReqToken`	`Specify Request Token as value or ref in stepDefinition {0}`
`SpecifyValueOrRefAccToken`	`Specify Access Token as value or ref in stepDefinition {0}`
`SpecifyValueOrRefConKey`	`Specify Consumer Key as value or ref in stepDefinition {0}`
`SpecifyValueOrRefAppKey`	`Specify App Key as value or ref in stepDefinition {0}`
`ExpiresInNotApplicableForOperation`	`ExpiresIn element is not valid for operation {0}`
`InvalidValueForExpiresIn`	`Invalid value for ExpiresIn element for operation {0}`
`FailedToFetchApiProduct`	`Failed to fetch api product for key {0}`
`InvalidTokenType`	`Valid token types : {0}, Invalid toke type {1} in stepDefinition {2}`
`TokenValueRequired`	`Token value is required in stepDefinition {0}`
`FailedToResolveRealm`	`Failed to resolve realm {0}`

Kebijakan GetOAuthV1Info

No error codes are specified for the Get OAuth v1.0a Info policy.

Kebijakan DeleteOAuthV1Info

On success, the policy returns a 200 status.

On failure, the policy returns 404 and output similar to the following (depending on whether you are deleting an access token, request token, or verifier.):

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Access Token","detail":{"errorcode":"keymanagement.service.invalid_request-access_token_invalid"}}}

Kebijakan PythonScript

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.script.ScriptEvaluationFailed`	500	The PythonScript policy can throw several different types of ScriptExecutionFailed errors. Commonly seen types of errors include NameError and ZeroDivisionError.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidResourceUrlFormat`	If the format of the resource URL specified within the `<ResourceURL>` or the `<IncludeURL>` element of the PythonScript policy is invalid, then the deployment of the API proxy fails.
`InvalidResourceUrlReference`	If the `<ResourceURL>` or the `<IncludeURL>` elements refer to a PythonScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ScriptExecutionFailed"`
`pythonscript.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`pythonscript.PythonScript-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError: "status" is not defined.\"",
    "detail": {
      "errorcode": "steps.script.ScriptExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="PythonScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(pythonscript.PythonScript-1.failed = true) </Condition>
</FaultRule>

Kebijakan Kuota

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error	Status HTTP	Penyebab	Perbaiki
`policies.ratelimit.FailedToResolveQuotaIntervalReference`	500	Terjadi jika elemen `<Interval>` tidak ditentukan dalam kebijakan Quota. Elemen ini bersifat wajib dan digunakan untuk menentukan interval waktu yang berlaku untuk kuota. Interval waktu bisa berupa menit, jam, hari, minggu, atau bulan seperti yang ditentukan dengan elemen `<TimeUnit>`.
`policies.ratelimit.FailedToResolveQuotaIntervalTimeUnitReference`	500	Terjadi jika elemen `<TimeUnit>` tidak ditentukan dalam kebijakan Quota. Elemen ini bersifat wajib dan digunakan untuk menentukan satuan waktu yang berlaku untuk kuota. Interval waktu bisa dalam hitungan menit, jam, hari, minggu, atau bulan.
`policies.ratelimit.InvalidMessageWeight`	500	Terjadi jika nilai elemen `<MessageWeight>` ditentukan melalui variabel flow tidak valid (nilai bukan bilangan bulat).
`policies.ratelimit.QuotaViolation`	500	Batas kuota terlampaui.	T/A

Error saat deployment

Nama error	Penyebab	Perbaiki
`InvalidQuotaInterval`	Jika interval kuota yang ditentukan dalam elemen `<Interval>` tidak bilangan bulat, maka deployment proxy API akan gagal. Misalnya, jika interval kuota yang ditentukan adalah 0.1 dalam elemen `<Interval>`, maka deployment Proxy API gagal.
`InvalidQuotaTimeUnit`	Jika satuan waktu yang ditentukan dalam elemen `<TimeUnit>` tidak didukung, maka deployment proxy API akan gagal. Satuan waktu yang didukung adalah `minute`, `hour`, `day`, `week`, dan `month`.
`InvalidQuotaType`	Jika jenis kuota yang ditentukan oleh atribut `type` di `<Quota>` tidak valid, maka deployment proxy API akan gagal. Tujuan jenis kuota yang didukung adalah `default`, `calendar`, `flexi`, dan `rollingwindow`.
`InvalidStartTime`	Jika format waktu yang ditentukan dalam elemen `<StartTime>` adalah tidak valid, berarti deployment proxy API akan gagal. Format yang valid adalah `yyyy-MM-dd HH:mm:ss`, yang merupakan format tanggal dan waktu ISO 8601. Sebagai contoh, jika waktu yang ditentukan dalam elemen `<StartTime>` `7-16-2017 12:00:00`, deployment proxy API akan gagal.
`StartTimeNotSupported`	Jika elemen `<StartTime>` ditentukan yang jenis kuotanya tidak `calendar`, deployment proxy API akan gagal. Elemen `<StartTime>` merupakan hanya didukung untuk jenis kuota `calendar`. Misalnya, jika atribut `type` ditetapkan ke `flexi` atau `rolling window` dalam elemen `<Quota>`, lalu deployment proxy API gagal.
`InvalidTimeUnitForDistributedQuota`	Jika elemen `<Distributed>` disetel ke `true` dan elemen `<TimeUnit>` disetel ke `second` maka deployment proxy API akan gagal. Satuan waktu `second` tidak valid untuk kuota terdistribusi.
`InvalidSynchronizeIntervalForAsyncConfiguration`	Jika nilai yang ditentukan untuk elemen `<SyncIntervalInSeconds>` dalam Elemen `<AsynchronousConfiguration>` dalam kebijakan Kuota kurang dari nol, maka deployment proxy API gagal.
`InvalidAsynchronizeConfigurationForSynchronousQuota`	Jika nilai elemen `<AsynchronousConfiguration>` disetel ke `true` dalam kebijakan Kuota, yang juga memiliki konfigurasi asinkron yang ditentukan menggunakan elemen `<AsynchronousConfiguration>`, maka deployment proxy API gagal.

Variabel kesalahan

Variabel ini ditetapkan saat kebijakan ini memicu error. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "QuotaViolation"`
`ratelimit.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`ratelimit.QT-QuotaPolicy.failed = true`

Contoh respons error

Catatan: Untuk penanganan error, praktik terbaiknya adalah menjebak errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena bisa saja berubah.

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      },
      "faultstring":"Rate limit quota violation. Quota limit  exceeded. Identifier : _default"
   }
}

Contoh aturan kesalahan

<FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "QuotaViolation") </Condition>
        </Step>
        <Condition>ratelimit.Quota-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

Kebijakan ResetQuota

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`policies.resetquota.InvalidRLPolicy`	500	The Quota policy specified in the `<Quota>` element of the Reset Quota policy is not defined in the API proxy and thus is not available during the flow. The `<Quota>` element is mandatory and identifies the target Quota policy whose counter should be updated through the Reset Quota policy.
`policies.resetquota.FailedToResolveAllowCountRef`	N/A	The reference to the variable containing the allow count in the `<Allow>` element of the policy cannot be resolved to a value. This element is mandatory and specifies the amount to decrease the quota counter.
`policies.resetquota.FailedToResolveRLPolicy`	500	The variable referenced by the `ref` attribute in the `<Quota>` element cannot be resolved.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidCount`	If the count value specified in the `<Allow>` element of the Reset Quota Policy is not an integer, then the deployment of the API proxy fails.

Kebijakan RaiseFault

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan serta variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode error	Status HTTP	Penyebab
`steps.raisefault.RaiseFault`	500	Lihat string kesalahan.

Error saat deployment

Tidak ada.

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam Tabel Error runtime di atas. Nama {i>error <i}adalah yang bagian dari kode kesalahan.	`fault.name = "RaiseFault"`
`raisefault.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna memberikan kesalahan.	`raisefault.RF-ThrowError.failed = true`

Contoh respons error

Catatan: Untuk penanganan error, praktik terbaiknya adalah menjebak errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena bisa saja berubah.

{
   "fault":{
      "detail":{
         "errorcode":"steps.raisefault.RaiseFault"
      },
      "faultstring":"Raising fault. Fault name: [name]"
   }
}

Kebijakan RegularExpressionProtection

This section describes the error codes and messages returned and fault variables set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. If you want to capture an error and raise your own custom error, set the continueOnError="true" attribute on the policy root element. To learn more, see What you need to know about policy errors and Handling faults.

Errors returned from Edge policies follow a consistent format as described in the Error code reference.

Runtime errors

These errors can occur when the policy executes.

Error Code	Message

ExecutionFailed	Failed to execute the RegularExpressionProtection StepDefinition {0}. Reason: {1}
InstantiationFailed	Failed to instantiate the RegularExpressionProtection StepDefinition {0}
NonMessageVariable	Variable {0} does not resolve to a Message
SourceMessageNotAvailable	{0} message is not available for RegularExpressionProtection StepDefinition {1}
ThreatDetected	Regular Expression Threat Detected in {0}: regex: {1} input: {2}
VariableResolutionFailed	Failed to resolve variable {0}

Deployment errors

Error Code	Message	Fix

CannotBeConvertedToNodeset	RegularExpressionProtection {0}: Result of xpath {1} cannot be converted to nodeset. Context {2}
DuplicatePrefix	RegularExpressionProtection {0}: Duplicate prefix {1}
EmptyJSONPathExpression	RegularExpressionProtection {0}: Empty JSONPath expression
EmptyXPathExpression	RegularExpressionProtection {0}: Empty XPath expression
InvalidRegularExpression	RegularExpressionProtection {0}: Invalid Regular Expression {1}, Context {2}
JSONPathCompilationFailed	RegularExpressionProtection {0}: Failed to compile jsonpath {1}. Context {2}
NONEmptyPrefixMappedToEmptyURI	RegularExpressionProtection {0}: Non-empty prefix {1} cannot be mapped to empty uri
NoPatternsToEnforce	RegularExpressionProtection {0}: No patterns to enforce in {1}
NothingToEnforce	RegularExpressionProtection {0}: at least one of URIPath, QueryParam, Header, FormParam, XMLPayload, JSONPayload is mandatory
XPathCompilationFailed	RegularExpressionProtection {0}: Failed to compile xpath {1}. Context {2}

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the table above.	`fault.name Matches "ThreatDetected"`
`regularexpressionprotection.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`regularexpressionprotection.Regular-Expressions-Protection-1.failed = true`

Kebijakan SOAPMessageValidation

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix

steps.messagevalidation.SourceMessageNotAvailable

500

This error occurs if a variable specified in the <Source> element of the policy is either:

out of scope (not available in the specific flow where the policy is being executed)
can't be resolved (is not defined)

steps.messagevalidation.NonMessageVariable

500

This error occurs if the <Source> element in the SOAPMessageValidation policy is set to a variable which is not of type message.

Message type variables represent entire HTTP requests and responses. The built-in Edge flow variables request, response, and message are of type message. To learn more about message variables, see the Variables reference.

steps.messagevalidation.Failed 500 This error occurs if the SOAPMessageValidation policy fails to validate the input message payload against the XSD schema or WSDL definition. It will also occur if there is malformed JSON or XML in the payload message.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidResourceType`	The `<ResourceURL>` element in the SOAPMessageValidation policy is set to a resource type not supported by the policy.
`ResourceCompileFailed`	The resource script referenced in the `<ResourceURL>` element of the SOAPMessageValidation policy contains an error that prevents it from compiling.
`RootElementNameUnspecified`	The `<Element>` element in the SOAPMessageValidation policy does not contain the root element's name.
`InvalidRootElementName`	The `<Element>` element in the SOAPMessageValidation policy contains a root element name that does not adhere to XML rules for valid element naming.

Kebijakan SAMLAssertion

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`SourceNotConfigured`	One or more of the following elements of the Validate SAML Assertion policy is not defined or empty: `<Source>`, `<XPath>`, `<Namespaces>`, `<Namespace>`.
`TrustStoreNotConfigured`	If the `<TrustStore>` element is empty or not specified in the ValidateSAMLAssertion policy, then the deployment of the API proxy fails. A valid Trust Store is required.
`NullKeyStoreAlias`	If the child element `<Alias>` is empty or not specified in the `<Keystore>` element of Generate SAML Assertion policy, then the deployment of the API proxy fails. A valid Keystore alias is required.
`NullKeyStore`	If the child element `<Name>` is empty or not specified in the `<Keystore>` element of GenerateSAMLAssertion policy, then the deployment of the API proxy fails. A valid Keystore name is required.
`NullIssuer`	If the `<Issuer>` element is empty or not specified in the Generate SAML Assertion policy, then the deployment of the API proxy fails. A valid `<Issuer>` value is required.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault. The fault name is the last part of the fault code.	`fault.name = "InvalidMediaTpe"`
`GenerateSAMLAssertion.failed`	For a validate SAML assertion policy configuration, the error prefix is `ValidateSAMLAssertion`.	`GenerateSAMLAssertion.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "GenerateSAMLAssertion[GenSAMLAssert]: Invalid media type",
    "detail": {
      "errorcode": "steps.saml.generate.InvalidMediaTpe"
    }
  }
}

Example fault rule

<FaultRules>
    <FaultRule name="invalid_saml_rule">
        <Step>
            <Name>invalid-saml</Name>
        </Step>
        <Condition>(GenerateSAMLAssertion.failed = "true")</Condition>
    </FaultRule>
</FaultRules>

Kebijakan ServiceCallout

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix

steps.servicecallout.ExecutionFailed

500

This error can occur when:

the policy is asked to handle input that is malformed or otherwise invalid.
the backend target service returns an error status (by default, 4xx or 5xx).

steps.servicecallout.RequestVariableNotMessageType 500 The Request variable specified in the policy is not of type Message. For example, if it's a string or other non-message type, you'll see this error.

steps.servicecallout.RequestVariableNotRequestMessageType 500 The Request variable specified in the policy is not of type Request Message. For example, if it's a Response type, you'll see this error.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`URLMissing`	The `<URL>` element inside `<HTTPTargetConnection>` is missing or empty.
`ConnectionInfoMissing`	This error happens if the policy does not have an `<HTTPTargetConnection>` or `<LocalTargetConnection>` element.
`InvalidTimeoutValue`	This error happens if the `<Timeout>` value is negative or zero.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "RequestVariableNotMessageType"`
`servicecallout.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`servicecallout.SC-GetUserData.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.servicecallout.RequestVariableNotMessageType"
      },
      "faultstring":"ServiceCallout[ServiceCalloutGetMockResponse]: 
            request variable data_str value is not of type Message"
   }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="RequestVariableNotMessageType">
    <Step>
        <Name>AM-RequestVariableNotMessageType</Name>
    </Step>
    <Condition>(fault.name = "RequestVariableNotMessageType")</Condition>
</FaultRule>

Kebijakan SpikeArrest

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`policies.ratelimit.FailedToResolveSpikeArrestRate`	`500`	This error occurs if the reference to the variable containing the rate setting within the `<Rate>` element cannot be resolved to a value within the Spike Arrest policy. This element is mandatory and used to specify the spike arrest rate in the form of `intpm` or `intps`.
`policies.ratelimit.InvalidMessageWeight`	`500`	This error occurs if the value specified for the `<MessageWeight>` element through a flow variable is invalid (a non-integer value).
`policies.ratelimit.SpikeArrestViolation`	`429`	The rate limit was exceeded. Note: For Private Cloud, the default HTTP status code returned is `500`. To change the status code returned to `429`, set this property with the API call described in Example fault rule

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidAllowedRate`	If the spike arrest rate specified in the `<Rate>` element of the Spike Arrest Policy is not an integer or if the rate does not have `ps` or `pm` as a suffix, then the deployment of the API proxy fails.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "SpikeArrestViolation"`
`ratelimit.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`ratelimit.SA-SpikeArrestPolicy.failed = true`

Example error response

Shown below is an example error response:

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

Example fault rule

Shown below is an example fault rule to handle a SpikeArrestViolation fault:

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

Kebijakan StatisticsCollector

Runtime errors

None.

Deployment errors

Error name	Cause	Fix
`UnsupportedDatatype`	If the type of the variable specified by the ref attribute in the `<Statistic>` element of the Statistics Collector policy is unsupported, then the deployment of the API proxy fails. The supported data types are `string`, `integer`, `float`, `long`, `double`, and `boolean`.
`InvalidName`	If the name used to reference the data collected for the specified variable defined within the `<Statistic>` element of the Statistics Collector policy conflicts with a system-defined variable, then the deployment of the API proxy fails. Some of the known system-defined variables are `organization` and `environment`.
`DatatypeMissing`	If the type of the variable specified by the `ref` attribute in the `<Statistic>` element of the Statistics Collector policy is missing, then the deployment of the API proxy fails.

Fault variables

None.

Kebijakan VerifyAPIKey

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan serta variabel kesalahan yang ditetapkan oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode kesalahan	Status HTTP	Penyebab
`keymanagement.service.CompanyStatusNotActive`	401	Perusahaan yang terkait dengan Aplikasi Developer yang memiliki kunci API yang Anda gunakan memiliki status tidak aktif. Jika status Perusahaan ditetapkan ke tidak aktif, Anda tidak dapat mengakses developer atau aplikasi yang terkait dengan Perusahaan tersebut. Admin organisasi dapat mengubah status Perusahaan menggunakan Management API. Lihat Menetapkan Status Perusahaan.
`keymanagement.service.DeveloperStatusNotActive`	401	Developer yang membuat Aplikasi Developer yang memiliki kunci API yang Anda gunakan memiliki status tidak aktif. Jika status Developer Aplikasi disetel ke tidak aktif, semua Aplikasi Developer yang dibuat oleh developer tersebut akan dinonaktifkan. Pengguna admin dengan izin yang sesuai (seperti Administrator Organisasi) dapat mengubah status developer dengan cara berikut: Management API: Set Developer Status UI Pengelolaan: Di Mendaftarkan developer aplikasi, lihat petunjuk untuk menonaktifkan (dan mengaktifkan) developer.
`keymanagement.service.invalid_client-app_not_approved`	401	Aplikasi Developer yang terkait dengan kunci API dicabut. Aplikasi yang dicabut aksesnya tidak dapat mengakses produk API apa pun dan tidak dapat memanggil API apa pun yang dikelola oleh Apigee Edge. Admin organisasi dapat mengubah status Aplikasi Developer menggunakan Management API. Lihat Menyetujui atau Mencabut Aplikasi Developer.
`oauth.v2.FailedToResolveAPIKey`	401	Kebijakan ini mengharapkan untuk menemukan kunci API dalam variabel yang ditentukan dalam elemen <APIKey> kebijakan. Error ini muncul saat variabel yang diharapkan tidak ada (tidak dapat diselesaikan).
`oauth.v2.InvalidApiKey`	401	Kunci API diterima oleh Edge, tetapi tidak valid. Saat Edge mencari kunci di database-nya, kunci tersebut harus sama persis dengan kunci yang dikirim dalam permintaan. Jika API berfungsi sebelumnya, pastikan kunci tidak dibuat ulang. Jika kunci dibuat ulang, Anda akan melihat error ini jika mencoba menggunakan kunci lama. Untuk mengetahui detailnya, lihat Mendaftarkan aplikasi dan mengelola kunci API.
`oauth.v2.InvalidApiKeyForGivenResource`	401	Kunci API diterima oleh Edge, dan valid; namun, kunci tersebut tidak cocok dengan kunci yang disetujui di Aplikasi Developer yang terkait dengan proxy API Anda melalui Produk.

Catatan: Saat ini, Edge tidak melaporkan error ApiKeyNotApproved secara akurat. Namun, jika kunci tidak disetujui (statusnya disetel ke "dicabut" atau "tertunda"), Anda akan mendapatkan error FailedToResolveAPIKey. Untuk mengetahui informasi selengkapnya dan kemungkinan solusi, lihat postingan ini di Komunitas Apigee.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab
`SpecifyValueOrRefApiKey`	Elemen `<APIKey>` tidak memiliki nilai atau kunci yang ditentukan.

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk mengetahui informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "FailedToResolveAPIKey"`
`oauthV2.policy_name.failed`	`policy_name` adalah nama kebijakan yang ditentukan pengguna yang menyebabkan kesalahan.	`oauthV2.VK-VerifyAPIKey.failed = true`

Contoh respons error

Catatan: Untuk penanganan error, praktik terbaiknya adalah menangkap bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena dapat berubah.

{
   "fault":{
      "faultstring":"Invalid ApiKey",
      "detail":{
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{
   "fault":{
      "detail":{
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

Contoh aturan kesalahan

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

Kebijakan VerifyJWS

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Edge saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Terjadi saat
`steps.jws.AlgorithmInTokenNotPresentInConfiguration`	401	Terjadi saat kebijakan verifikasi memiliki beberapa algoritma
`steps.jws.AlgorithmMismatch`	401	Algoritme yang ditentukan dalam header oleh kebijakan Pembuatan tidak cocok dengan yang diharapkan dalam kebijakan Verifikasi. Algoritma yang ditentukan harus cocok.
`steps.jws.ContentIsNotDetached`	401	`<DetachedContent>` ditentukan saat JWS tidak berisi payload konten terpisah.
`steps.jws.FailedToDecode`	401	Kebijakan tidak dapat mendekode JWS. JWS mungkin rusak.
`steps.jws.InsufficientKeyLength`	401	Untuk kunci kurang dari 32 byte untuk algoritma HS256
`steps.jws.InvalidClaim`	401	Karena klaim atau klaim tidak cocok, atau ketidakcocokan header atau header tidak ada.
`steps.jws.InvalidCurve`	401	Kurva yang ditentukan oleh kunci tidak valid untuk algoritma Kurva Eliptis.
`steps.jws.InvalidJsonFormat`	401	JSON yang tidak valid ditemukan di header JWS.
`steps.jws.InvalidJws`	401	Error ini terjadi saat verifikasi tanda tangan JWS gagal.
`steps.jws.InvalidPayload`	401	Payload JWS tidak valid.
`steps.jws.InvalidSignature`	401	`<DetachedContent>` dihilangkan dan JWS memiliki payload konten terpisah.
`steps.jws.KeyIdMissing`	401	Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi JWS yang ditandatangani tidak menyertakan properti `kid` di header.
`steps.jws.KeyParsingFailed`	401	Kunci publik tidak dapat diuraikan dari informasi kunci yang diberikan.
`steps.jws.MissingPayload`	401	Payload JWS tidak ada.
`steps.jws.NoAlgorithmFoundInHeader`	401	Terjadi saat JWS menghilangkan header algoritma.
`steps.jws.NoMatchingPublicKey`	401	Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi `kid` dalam JWS yang ditandatangani tidak tercantum di JWKS.
`steps.jws.UnhandledCriticalHeader`	401	Header yang ditemukan oleh kebijakan Verifikasi JWS di header `crit` tidak tercantum di `KnownHeaders`.
`steps.jws.UnknownException`	401	Terjadi pengecualian yang tidak diketahui.
`steps.jws.WrongKeyType`	401	Jenis kunci yang ditentukan salah. Misalnya, jika Anda menentukan kunci RSA untuk algoritma Kurva Elliptik, atau kunci kurva untuk algoritma RSA.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error Terjadi saat

InvalidAlgorithm Satu-satunya nilai yang valid adalah: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

Kemungkinan error deployment lainnya.

Variabel error

Variabel ini ditetapkan saat error runtime terjadi. Untuk mengetahui informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Dari mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error.	`fault.name Matches "TokenExpired"`
`JWS.failed`	Semua kebijakan JWS menetapkan variabel yang sama jika terjadi kegagalan.	`jws.JWS-Policy.failed = true`

Contoh respons error

Untuk penanganan error, praktik terbaiknya adalah menjebak bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena teks tersebut dapat berubah.

Contoh aturan error

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

Kebijakan VerifyJWT

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Occurs when
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	Occurs when the verification policy has multiple algorithms.
`steps.jwt.AlgorithmMismatch`	401	The algorithm specified in the Generate policy did not match the one expected in the Verify policy. The algorithms specified must match.
`steps.jwt.FailedToDecode`	401	The policy was unable to decode the JWT. The JWT is possibly corrupted.
`steps.jwt.GenerationFailed`	401	The policy was unable to generate the JWT.
`steps.jwt.InsufficientKeyLength`	401	For a key less than 32 bytes for the HS256 algorithm, less than 48 bytes for the HS386 algortithm, and less than 64 bytes for the HS512 algorithm.
`steps.jwt.InvalidClaim`	401	For a missing claim or claim mismatch, or a missing header or header mismatch.
`steps.jwt.InvalidCurve`	401	The curve specified by the key is not valid for the Elliptic Curve algorithm.
`steps.jwt.InvalidJsonFormat`	401	Invalid JSON found in the header or payload.
`steps.jwt.InvalidToken`	401	This error occurs when the JWT signature verification fails.
`steps.jwt.JwtAudienceMismatch`	401	The audience claim failed on token verification.
`steps.jwt.JwtIssuerMismatch`	401	The issuer claim failed on token verification.
`steps.jwt.JwtSubjectMismatch`	401	The subject claim failed on token verification.
`steps.jwt.KeyIdMissing`	401	The Verify policy uses a JWKS as a source for public keys, but the signed JWT does not include a `kid` property in the header.
`steps.jwt.KeyParsingFailed`	401	The public key could not be parsed from the given key information.
`steps.jwt.NoAlgorithmFoundInHeader`	401	Occurs when the JWT contains no algorithm header.
`steps.jwt.NoMatchingPublicKey`	401	The Verify policy uses a JWKS as a source for public keys, but the `kid` in the signed JWT is not listed in the JWKS.
`steps.jwt.SigningFailed`	401	In GenerateJWT, for a key less than the minimum size for the HS384 or HS512 algorithms
`steps.jwt.TokenExpired`	401	The policy attempts to verify an expired token.
`steps.jwt.TokenNotYetValid`	401	The token is not yet valid.
`steps.jwt.UnhandledCriticalHeader`	401	A header found by the Verify JWT policy in the `crit` header is not listed in `KnownHeaders`.
`steps.jwt.UnknownException`	401	An unknown exception occurred.
`steps.jwt.WrongKeyType`	401	Wrong type of key specified. For example, if you specify an RSA key for an Elliptic Curve algorithm, or a curve key for an RSA algorithm.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidNameForAdditionalClaim`	The deployment will fail if the claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is one of the following registered names: `kid`, `iss`, `sub`, `aud`, `iat`, `exp`, `nbf`, or `jti`.
`InvalidTypeForAdditionalClaim`	If the claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is not of type `string`, `number`, `boolean`, or `map`, the deployment will fail.
`MissingNameForAdditionalClaim`	If the name of the claim is not specified in the child element `<Claim>` of the `<AdditionalClaims>` element, the deployment will fail.
`InvalidNameForAdditionalHeader`	This error ccurs when the name of the claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is either `alg` or `typ`.
`InvalidTypeForAdditionalHeader`	If the type of claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is not of type `string`, `number`, `boolean`, or `map`, the deployment will fail.
`InvalidValueOfArrayAttribute`	This error occurs when the value of the array attribute in the child element `<Claim>` of the `<AdditionalClaims>` element is not set to `true` or `false`.
`InvalidValueForElement`	If the value specified in the `<Algorithm>` element is not a supported value, the deployment will fail.
`MissingConfigurationElement`	This error will occur if the `<PrivateKey>` element is not used with RSA family algorithms or the `<SecretKey>` element is not used with HS Family algorithms.
`InvalidKeyConfiguration`	If the child element `<Value>` is not defined in the `<PrivateKey>` or `<SecretKey>` elements, the deployment will fail.
`EmptyElementForKeyConfiguration`	If the ref attribute of the child element `<Value>` of the `<PrivateKey>` or `<SecretKey>` elements is empty or unspecified, the deployment will fail.
`InvalidConfigurationForVerify`	This error occurs if the `<Id>` element is defined within the `<SecretKey>` element.
`InvalidEmptyElement`	This error occurs if the `<Source>` element of the Verify JWT policy is empty. If present, it must be defined with an Edge flow variable name.
`InvalidPublicKeyValue`	If the value used in the child element `<JWKS>` of the `<PublicKey>` element does not use a valid format as specified in RFC 7517, the deployment will fail.
`InvalidConfigurationForActionAndAlgorithm`	If the `<PrivateKey>` element is used with HS Family algorithms or the `<SecretKey>` element is used with RSA Family algorithms, the deployment will fail.

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Di mana	Contoh
`fault.name="fault_name"`	`fault_name` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime di atas. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "TokenExpired"`
`JWT.failed`	Semua kebijakan JWT menetapkan variabel yang sama jika terjadi kegagalan.	`JWT.failed = true`

Contoh respons error

Kode Kesalahan Kebijakan JWT

Untuk penanganan error, praktik terbaiknya adalah menangkap bagian errorcode dari error yang dihasilkan. Jangan mengandalkan teks di faultstring, karena dapat berubah.

Contoh aturan kesalahan

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

Kebijakan XMLThreatProtection

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.xmlthreatprotection.ExecutionFailed`	500	The XMLThreatProtection policy can throw many different types of ExecutionFailed errors. Most of these errors occur when a specific threshold set in the policy is exceeded. These types of errors include: element name length, child count, node depth, attribute count, attribute name length, and many others. You can see the complete list in the XMLThreatProtection policy runtime error troubleshooting topic.
`steps.xmlthreatprotection.InvalidXMLPayload`	500	This error occurs if the input message payload specified by the XMLThreatProtection policy's `<Source>` element is not a valid XML Document.
`steps.xmlthreatprotection.SourceUnavailable`	500	This error occurs if the message variable specified in the `<Source>` element is either: Out of scope (not available in the specific flow where the policy is being executed) Is not one of the valid values `request`, `response`, or `message`
`steps.xmlthreatprotection.NonMessageVariable`	500	This error occurs if the `<Source>` element is set to a variable which is not of type message.

Notes:

The error name ExecutionFailed is the default error name and will be returned regardless of the type of error detected; however, this default can be changed by setting an organization-level property. When this property is set, the error name will reflect the actual error. For example, "TextExceeded" or "AttrValueExceeded". See Usage Notes for details.
The 500 HTTP status is the default; however, the HTTP Status can be changed to 400 for request flow faults by setting an organization-level property. See Usage Notes for details.

Deployment errors

None.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "SourceUnavailable"`
`xmlattack.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`xmlattack.XPT-SecureRequest.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "XMLThreatProtection[XPT-SecureRequest]: Execution failed. reason: XMLThreatProtection[XTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.xmlthreatprotection.ExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="XML Threat Protection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(xmlattack.XPT-SecureRequest.failed = true) </Condition>
</FaultRule>

Kebijakan XMLtoJSON

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.xmltojson.ExecutionFailed`	500	This error occurs when the input payload (XML) is empty or the input XML is invalid or malformed.
`steps.xmltojson.InCompatibleType`	500	This error occurs if the type of the variable defined in the `<Source>` element and the `<OutputVariable>` element are not the same. It is mandatory that the type of the variables contained within the `<Source>` element and the `<OutputVariable>` element matches.
`steps.xmltojson.InvalidSourceType`	500	This error occurs if the type of the variable used to define the `<Source>` element is invalid.The valid types of variable are message and string.
`steps.xmltojson.OutputVariableIsNotAvailable`	500	This error occurs if the variable specified in the `<Source>` element of the XML to JSON policy is of type string and the `<OutputVariable>` element is not defined. The `<OutputVariable>` element is mandatory when the variable defined in the `<Source>` element is of type string.
`steps.xmltojson.SourceUnavailable`	500	This error occurs if the message variable specified in the `<Source>` element of the XML to JSON policy is either: out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined)

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`EitherOptionOrFormat`	If one of the elements `<Options>` or `<Format>` is not declared in the XML to JSON Policy, then the deployment of the API proxy fails.
`UnknownFormat`	If the `<Format>` element within the XML to JSON policy has an unknown format defined, then the deployment of the API proxy fails. Predefined formats include: `xml.com`, `yahoo`, `google`, and `badgerFish`.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name = "SourceUnavailable"`
`xmltojson.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`xmltojson.XMLtoJSON-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

{
  "fault": {
    "faultstring": "XMLToJSON[XMLtoJSON-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.xml2json.SourceUnavailable"
    }
  }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="XML to JSON Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadXML</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(xmltojson.XMLtoJSON-1.failed = true) </Condition>
</FaultRule>

Kebijakan XSLTransform

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Penyebab	Perbaiki
`steps.xsl.XSLSourceMessageNotAvailable`	500	Error ini terjadi jika variabel string atau pesan yang ditentukan dalam elemen `<Source>` kebijakan Transformasi XSL berada di luar cakupan (tidak tersedia di alur tertentu tempat kebijakan dijalankan) atau tidak dapat diselesaikan (tidak ditentukan).
`steps.xsl.XSLEvaluationFailed`	500	Error ini terjadi jika payload XML input tidak tersedia/salah format atau kebijakan XSLTransform gagal/tidak dapat mengubah file XML input berdasarkan aturan transformasi yang disediakan dalam file XSL. Ada berbagai penyebab gagalnya kebijakan XSLTransform. Alasan kegagalan dalam pesan error akan memberikan informasi selengkapnya tentang penyebabnya.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaiki
`XSLEmptyResourceUrl`	Jika elemen `<ResourceURL>` dalam kebijakan Transformasi XSL kosong, deployment proxy API akan gagal.
`XSLInvalidResourceType`	Jika jenis resource yang ditentukan dalam elemen `<ResourceURL>` kebijakan Transformasi XSL bukan jenis `xsl`, deployment proxy API akan gagal.