Docs

Data Migration Service

Usage

Common Parameters

Public request parameters are required for each API endpoint. Developers must include these public request parameters whenever using VolcEngine API to send requests, otherwise the requests will fail. All public request parameters begin with a capital letter to distinguish them from interface request parameters.

Action and Version

tip

Action and Version must be included in the Query.

Name	Type	Required	Example value	Description
Action	String	Yes	CreateDataMigrateTask	Interface name, specifies the operation to perform Supported actions for file storage; see API Overview.
Version	String	Yes	2018-01-01	API version information, current version is 2018-01-01.
X-Expires	Int	No	300	The validity period of the signature in seconds. If not specified, the default is 900.

Signature parameters

Signature parameters are essential for requests and may be placed in the Header or Query.

Scenarios with parameters in the Header

Name	Type	Required	Description	Example value
X-Date	String	Yes	Use UTC time, accurate to the second, following the ISO 8601 format: YYYYMMDD'T'HHMMSS'Z'.	20201103T104027Z
Authorization	String	Yes	HTTP standard identity authentication header field. The format is HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}.	HMAC-SHA256 Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZkYzE/20201230/cn-north-1/iam/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=28eeabbbd726b87002e0fe58ad8c1c768e619b06e2646f35b6ad7ed029a6d8a7

The information in Authorization is explained in the following table.

Name	Type	Remarks
AccessKey	String	AccessKey information in the request. For instructions on how to view the AK and SK, see Viewing the Access Key ID and Secret Access Key.
ShortDate	String	Short time of request, accurate to the day. Use UTC time, for example: 20180201.
Region	String	Region to request, for example: North China 2 (Beijing): cn-beijing.
ServiceName	String	The requested service, currently dms.
SignedHeaders	String	Headers included in the signature, separated by semicolons.
Signature	String	Computed signature. For details about how to calculate the signature, see Signature mechanism.

In the Query scenario

Name	Type	Required	Description
X-Date	String	Yes	20201103T104027Z, use UTC time, accurate to the second.
X-Algorithm	String	Yes	Fixed value, HMAC-SHA256; reserved for future expansion.
X-Credential	String	Yes	Consists of {AccessKey}/{ShortDate}/{Region}/{Service}/request.
X-SignedHeaders	String	Yes	Headers involved in signature; separate multiple headers with semicolons.
X-Signature	String	Yes	Calculated signature. For details about the signature calculation method, see Signature mechanism.

Last updated: 2026.02.02 11:05:22