Call methods

Request Structure

When you call a API, a request is sent to the specified service endpoint. The request must be signed and contain the relevant business information so that the service can be successfully called. The following example shows the structure of a API request. The sample request is sent to call the DescribeCens action, and the request URL is not encoded. The request structure of OpenAPI is organized as follows, using an unencoded URL sample request for DescribeVpcEndpointServices as an example:

GET /?Action=DescribeTransitRouters&Version=2020-04-01&<Action_specific_request_parameters>​
Host: open.volcengineapi.com HTTP/1.1​
Region: cn-guangzhou​
Service: transitrouter​

GET specifies the HTTP method of the request. The Transit Router (TR) API supports only the GET method.

Action=DescribeTransitRouters specifies the API action you want to call. Version=2020-04-01 specifies the version of the API.

HTTP indicates the protocol of the request.

Host indicates the service endpoint.

Region and Service specify the Region and name of the service being requested. For more information, refer to Common parameters.

Service URL

The common endpoint for accessing APIs is open.volcengineapi.com.

Protocol

API requests can be communicated over HTTP or HTTPS. We recommend that you use HTTPS for higher security.

Request Method

For the request method, refer to the specific requirements of each API. The Transit Router (TR) API supports only Get requests.

tip

When you use the GET method, the Action and Version common parameters must be included in the Query String.

All request parameters must be in the URL-encoded format when the GET method is used.

Request Parameters

OpenAPI requests include two types of parameters: common request parameters and interface request parameters. Common request parameters are required for every API. For more information, refer to Common parameters. Interface request parameters are unique to each interface. For details, refer to the description of each interface.

Encoding

Requests and responses are encoded in UTF-8.

Last updated: 2025.02.10 14:34:21