Docs

Load Balancer

Call Methods

Request Method

When you call an 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 an 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 request example of DescribeVpcEndpointServices:

GET /?Action=DescribeLoadBalancers&Version=2020-04-01&<interface request parameter>​
Host: clb.cn-beijing.volcengineapi.com HTTP/1.1​
Region: cn-beijing​
Service: clb​

GET indicates that the Network Load Balancer's OpenAPI supports only GET requests.

Action=DescribeLoadBanlancers specifies the OpenAPI to be called, and Version=2020-04-01 specifies the version of the OpenAPI.

HTTP specifies the protocol of the request.

Host specifies the service endpoint.

Region and Service indicate the region and name of the service. For more information, refer to Common parameters.

Service URL

The general service endpoint of open APIs is clb.{RegionID}.volcengineapi.com.

Tip

Please refer to Region List to get the {RegionID}.

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 OpenAPIs of Network Load Balancer only support GET requests.

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.10.11 17:09:18