Docs

File Storage vePFS

Call method

Common Parameters

Common request parameters are required for all APIs. Developers must include these parameters every time they send a request using Volcano Engine API. Missing them will result in request failures. The initial letter of each common request parameter is capitalized to distinguish them from API request parameters.

Action and Version

tip

Action and Version must be included in the Query.

Name	Category	Required	Parameter format	Description
Action	String	Yes	[a-zA-Z]+	The interface name is related to the specific interface and indicates the operation to be performed.
Version	String	Yes	YYYY-MM-DD	API version information. The current version is 2022-01-01.
X-Expires	Int	Not supported	300	Signature validity period in seconds. The default value is 900 seconds if left blank.

Signature parameters

The signature parameter is required in every request and can be included in either the Header or Query.

Scenario for parameters in the Header

Name	Category	Required	Description
X-Date	String	Yes	20201103T104027Z, use UTC time, accurate to the second.
Authorization	String	Yes	HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature=

The information in the Authorization field is explained in the following table.

Name	Category	Remarks
AccessKey	String	Requested AK.
ShortDate	String	Short request time, accurate to the day. Use UTC time, for example: 20180201.
Region	String	Requested region, for example: North China 2 (Beijing): cn-beijing.
ServiceName	String	Requested service, currently vepfs.
SignedHeaders	String	Headers involved in the signature, separated by semicolons.
Signature	String	Computed signature. For details about the signature computation method, see Signature Mechanism.

Scenario for parameters in the Query

tip

X-Date and Authorization can be directly included in the Query.

Name	Category	Required	Description
X-Date	String	Yes	20201103T104027Z, uses UTC time accurate to the second.
X-Algorithm	String	Yes	Fixed value: HMAC-SHA256; prepared for future expansion.
X-Credential	String	Yes	Consists of {AccessKey}/{ShortDate}/{Region}/{Service}/request.
X-SignedHeaders	String	Yes	Signed headers, separated by semicolons.
X-Signature	String	Yes	Completed signature. For details on how to calculate the signature, see Signature Mechanism.

For more details, see Common Parameters.

Last updated: 2026.03.03 10:36:49