Docs

Elastic Compute Service

Call methods

Common parameters

Common request parameters are required for every API operation. Developers must include these common request parameters each time they send a request using VolcanoEngine APIs. Otherwise, the request will fail. The initial letters of all common request parameters are capitalized to distinguish them from request parameters specific to each API operation.

Action&Version

Action and Version must be included in the query string.

Term	Type	Required	Parameter format	Description
Action	String	Yes	[a-zA-Z]+	The name of the operation, which specifies the operation you want to perform.
Version	String	Yes	YYYY-MM-DD	The version information of the API. The current version is 2020-04-01.
X-Expires	Int	No	300	The validity period of the signature measured in seconds. Default value: 900.

Signature parameters

Signature parameters are an essential part of the request and can be placed in either the request header or the query string.

Term	Type	Required	Description
X-Date	String	Yes	20201103T104027Z. Use UTC time, accurate to seconds.
Authorization	String	Yes	HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature=

The following table describes the fields included in Authorization.

Term	Type	Remarks
AccessKey	String	The AK of the request.
ShortDate	String	The short date of the request, accurate to days. Use UTC time. Example: 20180201.
Region	String	The region of the request. For example, China (Beijing): cn-beijing. For more information about regions, see Region and availability zone.
Service	String	The requested service. To call a DDH API, set this parameter to ecs.
SignedHeaders	String	The headers involved in the signature calculation, separated with semicolons.
Signature	String	The calculated signature. For calculation methods, see Signature mechanism.

Scenarios where signature parameters are placed in the query string

X-Date and Authorization information can be directly included in the query string.

Term	Type	Required	Description
X-Date	String	Yes	20201103T104027Z. Use UTC time, accurate to seconds.
X-Algorithm	String	Yes	Fixed value: HMAC-SHA256. This field is used to prepare for future expansion.
X-Credential	String	Yes	The format is {AccessKey}/{ShortDate}/{Region}/{Service}/request.
X-SignedHeaders	String	Yes	The headers involved in the signature calculation, separated with semicolons.
X-Signature	String	Yes	The calculated signature. For calculation methods, see Signature mechanism.

Last updated: 2026.01.16 19:04:49