You need to enable JavaScript to run this app.
Container Registry

Container Registry

Copy page
Download PDF
call method
Public parameters
Copy page
Download PDF
Public parameters
Public request parameters are required for every API interface. Developers must include these parameters every time they send a request using the Volcano Engine OpenAPI. Otherwise, the request will fail. The first letters of common request parameters are all capitalized to distinguish them from other request parameters.​
Action and Version​
warning​
Action and Version must be placed in the Query.​
​
Name​
Type​
Required​
Parameter Format​
Description​
Action​
String​
Yes​
[a-zA-Z]+​
The name of the interface, specific to the interface being called.​
Version​
String​
Yes​
YYYY-MM-DD​
The version information of the interface, specific to the interface being called.​
X-Expires​
Int​
None​
300​
The validity period of the signature, measured in seconds. The default value is 900 seconds if not specified.​
​
Signature parameters​
tip​
The signature parameters are an essential part of the request, which can be placed either in the Header or the Query section of the request.​
Scenarios in the Header​
​
Name​
Type​
Required​
Description​
X-Date​
String​
Yes​
The UTC time is used, accurate to the second. Format following the ISO 8601 standard: YYYYMMDD'T'HHMMSS'Z', for example: 20201103T104027Z.​
Authorization​
String​
Yes​
The credential used to verify the legality of the request. Format: HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}.​
​
Meaning of the information in Authorization:​
​
Name​
Type​
Description​
AccessKey​
String​
The Access Key ID of the request.​
ShortDate​
String​
The short date of the request, accurate to the day. The UTC time is used, e.g., 20180201.​
Region Code​
String​
The requested Region, for example, North China 2 (Beijing), corresponds to cn-beijing.​
tip​
For more Region information, see Region and Availability Zone.​
Service​
String​
The requested service when calling the VMP service API is: vmp.​
SignedHeaders​
String​
The headers involved in the signature, separated by semicolons (;).​
Signature​
String​
The computed signature. For details on the signature calculation method, see Signature method.​
​
Scenarios in the Query​
The information for X-Date and Authorization can be directly included in the Query.​
​
Name​
Type​
Required​
Description​
X-Date​
String​
Yes​
The UTC time is used, accurate to the second, e.g., 20201103T104027Z.​
X-Algorithm​
String​
Yes​
The fixed value HMAC-SHA256 is used in preparation for future expansion.​
X-Credential​
String​
Yes​
It consists of {AccessKey}/{ShortDate}/{Region}/{Service}/request. For detailed explanations of the fields, please refer to the table above.​
X-SignedHeaders​
String​
Yes​
The headers involved in the signature, separated by semicolons (;).​
X-Signature​
String​
Yes​
The computed signature. To learn about the signature calculation method, see Signature method.​
​
​
Last updated: 2025.10.24 11:20:42