To call Volcengine OpenAPI, you need to send requests to the designated service endpoint, and include the required Volcano Engine signature information as well as the business-specific parameters for the particular API. This topic describes the basic structure and communication methods of OpenAPI requests.

Parameter description:

POST: The Cloud Monitor API only supports POST requests.

Host: Service endpoint. For details, see Service addresses.

Action={Action name}: The name of the API being called.

Version={Registered version}: The version of the API being called. For details, see Public parameters.

Region and ServiceName: The requested region and service name. For details, see Public parameters.

AccessKey and SecretKey: Credentials used to verify the signature information. For details, see Signature mechanism.

Data: The request parameters.

Communication protocols

Requests can be sent using either HTTP or HTTPS. We recommend using the more secure HTTPS protocol to send OpenAPI requests.

Request methods

For request method details, see the specific requirements of each API. Cloud Monitor OpenAPI only supports POST requests.

Request descriptions

An OpenAPI request contains the following two types of parameters:

Public request parameters: Parameters that must be included in every API call to the service. For details, see Public parameters.

API-specific request parameters: Parameters specific to different APIs. For details, see the description of each API.

Character encoding

Requests and responses are encoded using the UTF-8 character set.