Docs

Volcengine Managed Service for Prometheus

Calling method

Common parameters

Common request parameters are required for each API. Each time you send a request to a Volcano Engine OpenAPI, you must include these common request parameters. Otherwise, the request fails. The first letter of each common request parameter must be capitalized to distinguish these parameters from other request parameters.

Actions and Versions

warning

Action and Version must be placed in the query.

Name	Type	Is it required?	Parameter format	Description
Action	String	Yes	[a-zA-Z]+	Name of the API.
Version	String	Yes	YYYY-MM-DD	Version of the API.
X-Expires	Int	No	300	The signature lifetime in seconds. Leaving it empty indicates a default lifetime of 900 seconds.

Signature parameters

tip

Signature parameters are required in requests and need to be placed in headers or queries.

Name	Type	Required	Description
X-Date	String	Yes	It is time in UTC precise to the second. It follows ISO 8601 standard: YYYYMMDD'T'HHMMSS'Z', e.g., 20201103T104027Z.
Authorization	String	Yes	It is used to verify the validity of requests. The format is: HMAC-SHA256 Credential={AccessKey}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}.

Details in Authorization:

Name	Type	Note
AccessKey	String	Access key ID.
ShortDate	String	Date of the request, which is precise to the day. It is time in UTC, e.g., 20180201.
Region	String	The region to which requests are sent, e.g., cn-beijing is used to represent the region North China 2 (Beijing). tip For more information about regions, see Server-launching region.
Service	String	The service to be requested, e.g., vmp represents VMP service.
SignedHeaders	String	Headers involved in signing with semicolons (;) as separators.
Signature	String	Calculated signature. A signature that is ready to use. See Signature Method for details.

X-Date and Authorization can be placed directly in the query.

Name	Type	Required	Description
X-Date	String	Yes	It is time in UTC precise to the second, e.g., 20201103T104027Z.
X-Algorithm	String	Yes	The value is always HMAC-SHA256, which is reserved for future extensions.
X-Credential	String	Yes	It is composed of {AccessKey}/{ShortDate}/{Region}/{Service}/request. You can find the details about the fields in the previous table.
X-SignedHeaders	String	Yes	Headers involved in signing with semicolons (;) as separators.
X-Signature	String	Yes	A signature that is ready to use. See Signature Method for details.

Last updated: 2026.07.10 11:12:04