本文介绍缓存数据库 Redis 企业版的 API 请求结构信息。

服务地址 #

缓存数据库 Redis 企业版已开通服务的地域如下表。

通信协议 #

支持通过 HTTP 或 HTTPS 两种方式进行请求通信，推荐使用安全性更高的 HTTPS 方式来发送请求。

请求方法 #

支持 HTTP POST 请求方法，其中 POST 请求支持的 Content-Type 类型为 application/JSON（推荐）。

请求 URI #

您可以通过发送 HTTPS POST 请求来调用 Redis 的 API 服务。HTTPS 请求 URI 的格式如下：

POST {URI-scheme}://{Endpoint}/?Action={Action}&Version={Version} HTTP/1.1

其中：

• URI-scheme：表示用于传输请求的协议，当前所有 API 均采用 HTTPS 协议。
• Endpoint：指定承载服务端点的服务器域名或 IP，即服务地址。缓存数据库 Redis 企业版的服务地址为 redis.<RegionId>.volcengineapi.com。更多详情，请参见服务地址。
• Action：要执行的操作，此处请填写要调用的 API 接口名称。缓存数据库 Redis 企业版支持的 API 接口详情，请参见 API 列表。
• Version：API 版本号，格式为 YYYY-MM-DD 格式。缓存数据库 Redis 企业版的 API 版本号是 2020-12-07。

以在北京地域调用创建 Redis 实例接口为例，未编码的 HTTPS 请求 URI 如下。

https://redis.cn-beijing.volcengineapi.com/?Action=CreateEnterpriseDBInstance&Version=2020-12-07

请求参数 #

每个 API 请求都包含如下两类参数：

• 公共请求参数：每个 API 接口都需要使用的参数为公共请求参数。关于公共参数的更多详情，请参见公共参数。
• 接口请求参数：每个 API 接口特有的参数为接口请求。关于各个接口的请求参数，请参见 API 列表中各接口的详细描述。

字符编码 #

均使用 UTF-8 编码。