Docs

Volcano Engine Function as a Service

Call methods

Public parameter

Public request parameters are required for each interface. The developers need to carry these public request parameters every time they send a request using Volcano Engine OpenAPI, otherwise the request will fail. Public request parameters are capitalized to distinguish them from other request parameters.

Action and Version

warning

Action and Version must be placed in Query. E.g. ? Action=CreaeFunctiont & Version = 2024-06-06.

Name	Type	Required or Not	Parameter format	Description
Action	String	Yes	[a-zA-Z]+	The name of the interface is related to the specific interface itself.
Version	String	Yes	YYYY-MM-DD	The version information of the interface, related to the specific interface itself. Currently only supports 2024-06-06.

Signature parameters

tip

The signature parameters are an essential part of the request, and can be placed in the Header or Query.

Name	Type	Required or Not	Description
X-Date	String	Yes	Use UTC time, accurate to the second. Please use the format: YYYYMMDD T'HHMMSS'Z ', e.g.: 20201103T104027Z.
Authorization	String	Yes	The authentication information used to verify the legitimacy of the request. The format is: HMAC-SHA256 Credential = {AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders = {SignedHeaders}, Signature = {Signature}.

The meanings of information in Authorization:

Name	Type	Remarks
AccessKey	String	The Access Key ID of the request.
ShortDate	String	The short time of the request, accurate to the day. Use UTC time, e.g.: 20180201.
Region	String	The requested region (Region), e.g.: cn-beijing, represents the North China 2 (Beijing) region. For more information about regions, please refer to Server-launching region.
Service	String	The requested service is vefaas when calling the Function as a Service API.
SignedHeaders	String	Headers participating in the signature, separated by semicolons (;).
Signature	String	The calculated signature. For the signature calculation method, please refer to the Signature mechanism.

The X-Date scene

The X-Date scene in Query and the information in Authorization can directly be stored in Query.

Default CPU Request	Type	Required or Not	Description
X-Date	String	Yes	Use UTC time, accurate to the second, e.g.: 20201103T104027Z.
X-Algorithm	String	Yes	Fixed value HMAC-SHA256; to prepare for future expansion
X-Credential	String	Yes	Consists of {AccessKey}/{ShortDate}/{Region}/{Service}/request.
X-SignedHeaders	String	Yes	Headers participating in the signature, separated by semicolons (;).
X-Signature	String	Yes	The calculated signature. For the signature calculation method, please refer to the Signature mechanism.

Last updated: 2025.06.30 11:37:45