Docs

Cloud Native Message Engine

How to call an API

Common parameters

This topic describes the public parameters that must be provided when you call the API. Public parameters mainly include information such as the API version and authentication.

Signature parameters can be included in the Header or in the Query.

Header signature parameters

Parameters	Type	Required	Description
Action	String	Yes	API name, that is, the operation to be performed, for example CreateProject.
Version	String	Yes	API version. The API version for the cloud-native messaging engine is 2021-06-01.
X-Expires	Int	No	Signature validity period, in seconds. If not specified, the default value is 900 seconds.
X-Date	String	Yes	Use UTC time, accurate to the second. The format is YYYYMMDD'T'HHMMSS'Z', for example: 20201103T104027Z.
Authorization	String	Yes	HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature} The components are: AccessKeyId (String): The Access Key ID of the VolcanoEngine account initiating the request. ShortDate (String): The short date of the request, using UTC time, accurate to the day, in the format YYYYMMDD, for example: 20220201. Region (String): The region of the request, for example: cn-beijing. Service (String): The service of the request. The API request service for the cloud-native messaging engine is BMQ. SignedHeaders (String): The headers involved in the signature, separated by semicolons (;) if there are multiple headers. Signature (String): The calculated signature.
X-Security-Token	String	No	Refers to the SessionToken in the temporary security credentials issued by the Security Token Service (STS). This parameter is not required when using long-term keys.

Query signature parameters

Parameters	Type	Required	Description
Action	String	Yes	API name, that is, the operation to be performed, for example CreateProject.
Version	String	Yes	API version. The API version for the cloud-native messaging engine is 2021-06-01.
X-Expires	Int	No	Signature validity period, in seconds. If not specified, the default value is 900 seconds.
X-Date	String	Yes	Use UTC time, accurate to the second. The format is YYYYMMDD'T'HHMMSS'Z', for example: 20201103T104027Z.
X-Algorithm	String	Yes	Fixed value: HMAC-SHA256.
X-Credential	String	Yes	Authentication information, consisting of {AccessKeyId}/{ShortDate}/{Region}/{Service}/request. The components are: AccessKeyId (String): The Access Key ID of the VolcanoEngine account initiating the request. ShortDate (String): The short date of the request, using UTC time, accurate to the day, in the format YYYYMMDD, for example: 20220201. Region (String): The region of the request, for example: cn-beijing. Service (String): The service of the request. The API request service for the cloud-native messaging engine is BMQ.
X-SignedHeaders	String	Yes	The headers involved in the signature, separated by semicolons (;) if there are multiple headers.
X-Signature	String	Yes	The calculated signature.

Last updated: 2026.01.26 15:46:58