- Documentation
Server Migration Center
API Reference
Call methods
Request structure
Call methods
Request structure
Request structure
To call an OpenAPI operation of the VolcanoEngine platform, send a request to the specified service endpoint with VolcanoEngine platform signature and specific API service requirements. The OpenAPI request structure of the VolcanoEngine platform is organized as follows. An unencoded URL request for CreateMigrationJob is used as an example:
- GET specifies the request method. Server Migration Center (SMC) OpenAPI supports GET requests.
- Action=CreateMigrationJob specifies the API to be called, and Version=2020-04-01 is the API version.
- Host specifies the VolcanoEngine platform service endpoint.
- Region and Service indicate the region and name of the service. For more information, refer to Common parameters.
- HTTP specifies the protocol of the request.
Service address
The general service endpoint for the VolcanoEngine platform OpenAPIs is smc.volcengineapi.com.
Communication protocol
Requests can be sent via HTTP or HTTPS. We recommend that you use HTTPS for higher security.
Request methods
See the specific requirements of each API operation for request methods. The SMC OpenAPI supports GET requests.
warning
- The Action and Version parameters in the common parameters must be included in the query string.
- For GET requests, all parameters must be URL-encoded.
Request parameters
VolcanoEngine platform OpenAPI requests include two types of parameters: common request parameters and API-specific request parameters. Common request parameters are included in every API call. For more information, see Common parameters. API request parameters are specific to each API operation. For more information, see the description of the specific API.
Character encoding
Requests and responses are encoded using the UTF-8 character set.
Last updated: 2026.01.07 15:11:31