You need to enable JavaScript to run this app.
Copy page
Download PDF
Call method
Request structure
Copy page
Download PDF
Request structure
To call APIs, you must send requests to a specified service endpoint and meet signature and API service requirements. The request structure of VolcanoEngine's OpenAPI is organized as follows, taking CreateBandwidthPackage as an example:​
​
GET /?Action=CreateBandwidthPackage&<interface request parameter> HTTP/1.1​
Host:vpc.cn-beijing.volcengineapi.com HTTP/1.1​
Region: cn-beijing​
Service: vpc​
​
  • GET indicates that the OpenAPI in VolcanoEngine supports GET requests.​
  • Action=CreateBandwidthPackage specifies the OpenAPI to be called.​
  • HTTP indicates the protocol of the request.​
  • Host indicates the service endpoint.​
  • Region specifies the region that a request is sent to. For more information, see Common parameters.​
  • Service is the name of the service being requested.​
Protocol​
Bandwidth Package API requests can be sent by using HTTP or HTTPS. We recommend using HTTPS, as this method is more secure.​
Service URL​
The common endpoint for accessing APIs is vpc.{RegionID}.volcengineapi.com.​
Request method​
For the request method, see the specific requirements of each API. System open APIs support Get requests.​
Tip​
When you use GET to call an API, place the common parameters Action and Version in Query String and complete URL encoding for all request parameters.​
Request parameters​
OpenAPI requests include two types of parameters: common request parameters and API request parameters. Among them, the common request parameters are required for every API. For details, see common parameters. API request parameters are specific to each API. For details, see the description of each API.​
Encoding​
Requests and responses are encoded in UTF-8.​
​
Last updated: 2026.07.07 18:51:07