AllowedCloudExtraParameters

AllowedCloudExtraParameters

is an option for APIFunction and related functions that specifies whether parameters that affect overall cloud execution should be accepted.

Details

Examples

open allclose all

Basic Examples  (1)

Allow the caller of an APIFunction to set the format used for exporting the result:

If the "_exportform" parameter is not specified in the call, the APIFunction will not export the result:

Scope  (5)

When AllowedCloudExtraParameters is set to "_exportform", the response can be exported using any format from $ExportFormats, overriding the specified export format:

When AllowedCloudExtraParameters is set to "_responseform", a ResponseForm of the result can be returned:

When AllowedCloudExtraParameters is set to "_geolocation", the client can specify a different $GeoLocation:

When AllowedCloudExtraParameters is set to "_memorylimit", the client can specify a limit for memory usage:

When AllowedCloudExtraParameters is set to "_timeout", the client can specify a time limit for the execution:

Properties & Relations  (2)

Allowing for "_exportform" is effectively equivalent to setting the third argument of APIFunction:

Allowing for "_responseform" is effectively equivalent to wrapping the body of the APIFunction in ResponseForm:

Possible Issues  (1)

Letting API callers set the "_responseform" might expose details of the deployed API, such as internal messages:

Wolfram Research (2017), AllowedCloudExtraParameters, Wolfram Language function, https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html.

Text

Wolfram Research (2017), AllowedCloudExtraParameters, Wolfram Language function, https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html.

CMS

Wolfram Language. 2017. "AllowedCloudExtraParameters." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html.

APA

Wolfram Language. (2017). AllowedCloudExtraParameters. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html

BibTeX

@misc{reference.wolfram_2024_allowedcloudextraparameters, author="Wolfram Research", title="{AllowedCloudExtraParameters}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html}", note=[Accessed: 04-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_allowedcloudextraparameters, organization={Wolfram Research}, title={AllowedCloudExtraParameters}, year={2017}, url={https://reference.wolfram.com/language/ref/AllowedCloudExtraParameters.html}, note=[Accessed: 04-November-2024 ]}