This topic introduces the request structure used by Cache for Redis APIs.
Service endpoints
Cache for Redis is now available in regions listed in the table below.
Communication protocol
HTTPS protocol is supported for request communication, while the latter is recommended for sending requests to ensure higher security.
Request method
The HTTPS POST request method is supported. The supported Content-Type for POST requests is application/JSON (recommended).
Request URI
Call the Redis API services by sending HTTPS POST requests. The URL format for HTTPS requests is:
Among them:
- URI-scheme: The protocol used for transferring requests. All APIs currently use the HTTPS protocol.
- Endpoint: The domain name or IP address of the server assigned to host the service endpoint. It is also called the URL. The service address for Cache for Redis is redis.<RegionId>.volcengineapi.com. For more details, refer to Service endpoints.
- Action: The action to be performed. Enter the name of the API to be called here. For the APIs supported by Cache for Redis, refer to API overview.
- Version: The API version in the format YYYY-MM-DD. The API version of Cache for Redis is 2020-12-07.
For example, when calling the API to create a Redis instance in the Beijing region, the unencoded HTTPS request URI is as follows.
Request parameters
Every API request consists of two types of parameters:
- Common request parameters: Parameters that are required for every API. For more details on common parameters, refer to Common parameters.
- API-specific request parameters: Parameters specific to each API. For more details on the request parameters of each API, refer to API descriptions in API overview.
Character encoding
UTF-8 encoding is used for all requests.