Parameter | Required | Description |
Function | Yes | Select the namespace, name, and version of the verification function. |
Backend timeout | Yes | Set the backend timeout that API Gateway forwards the request to the verification function. The maximum time limit is 30 minutes. When no response is returned before the timeout after API Gateway calls the function, API Gateway will end the call and return an error message. |
Whether to send the Body | Yes | When the value is `Yes`, the Header, Body, and Query requested by the client will be sent to the function. When the value is `No`, the requested Body will not be sent. |
Verification Parameters | No | Set the request parameters for verification. When Cache Period is not `0`, this parameter must be set. When caching is enabled, the verification result will be queried with this parameter as the search criterion. |
Cache Period | Yes | Set the cache validity period for the verification result. `0` indicates that caching is not enabled. The cache validity period can be up to 3,600 seconds. |
Parameter | Required | Description |
Request method | Yes | Request method of the custom verification function, which can be GET, POST, PUT, DELETE, HEAD, and ANY. |
Public network service | Yes | Access address of the custom verification service, which can be an HTTP or HTTPS address. |
Path match mode | Yes | It can be backend path or full path match. Backend path match: The configured path is used to request the service. Full path match: The overlapping part is used to request the service. For example, if the configured API path is `/a/` and the request path is `/a/b`, then the path transferred to the service will be `/b` after full path match is enabled. |
Parameter | Required | Description |
VPC | Yes | Select the VPC of the verification service. |
Request method | Yes | Request method of the custom verification function, which can be GET, POST, PUT, DELETE, HEAD, and ANY. |
Backend address | Yes | Access address of the custom verification service, which can be an HTTP or HTTPS address. |
{"cache_time":10, // Verification result caching duration in seconds. Value range: 0–3600"endpoint_timeout":15, // Backend timeout period in seconds. Value range: 0–60"func_name":"test_name", // Custom SCF name"func_namespace":"test_namespace", // Custom SCF namespace"func_qualifier":"$LATEST", // Custom SCF version"is_send_body":true, // Whether to send the request Body to the SCF"header_auth_parameters":[ // Verification parameter in Header location. The plugin caches the verification result based on the parameter value"Header1"],"query_auth_parameters":[ // Verification parameter in Query location. The plugin caches the verification result based on the parameter value"Query1"],"user_id":1253970226, // appid"version":"2021-12-26 17:17:49" // Plugin version in the format of `yyyy-MM-dd HH:mm:ss`. When you edit the plugin, the new value passed in will invalidate the result cached in the plugin}
Was this page helpful?