创建缓存实例
功能介绍
创建缓存实例。
URI
POST /v1.0/{project_id}/instances
请求消息
请求参数
参数说明见表2。
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
name |
String |
是 |
实例名称。 由中英文字符开头，只能由中英文字母、数字、中划线和下划线组成，长度为4~64的字符。 |
|
description |
String |
否 |
实例的描述信息。 长度不超过1024的字符串。
说明：
\与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\\或者\"。 |
|
engine |
String |
是 |
缓存引擎：Redis。 |
|
engine_version |
String |
是 |
缓存版本，取值为4.0、5.0。
说明：
DCS自当前版本起，新建局点已暂停售卖Redis 3.0实例，取值为4.0、5.0。存量局点可以继续使用Redis 3.0，建议使用Redis 4.0及以上版本。 |
|
spec_code |
String |
是 |
DCS的产品规格编码。 具体取值可以在分布式缓存服务控制台，创建实例页面中查看“实例规格>规格名称”。 具体取值也可以查看 《分布式缓存服务用户指南》的“实例规格”章节，查找到对应的“产品规格编码”列。 |
|
capacity |
Float |
是 |
缓存容量（G Byte）。
|
|
password |
String |
是 |
缓存实例的认证信息。 Redis类型的缓存实例密码复杂度要求：
|
|
vpc_id |
String |
是 |
虚拟私有云ID。 获取方法如下：
|
|
security_group_id |
String |
是 |
指定实例所属的安全组。 当engine为Redis且engine_version为3.0时，该参数为必选。Redis3.0实例支持安全组访问控制。 当engine为Redis且engine_version为4.0及以上版本时，该参数为可选。Redis4.0及以上版本实例不支持安全组控制访问。 获取方法如下：
|
|
subnet_id |
String |
是 |
子网的网络ID。 获取方法如下：
|
|
available_zones |
Array |
是 |
创建缓存节点到指定且有资源的可用区ID。具体查询方法，请参考查询可用区信息，在查询时，请注意查看该可用区是否有资源。 如果是创建主备、Proxy集群、Cluster集群实例，支持跨可用区部署，可以为备节点指定备可用区。在为节点指定可用区时，用逗号分隔开，具体请查看示例。 |
|
instance_backup_policy |
Object |
否 |
|
|
maintain_begin |
String |
否 |
维护时间窗开始时间，格式为hh:mm:ss。
|
|
maintain_end |
String |
否 |
维护时间窗结束时间，格式为hh:mm:ss。
|
|
private_ips |
Array of strings |
否 |
创建缓存实例手动指定的IP地址。 |
|
port |
Integer |
否 |
实例自定义端口。只有创建Redis4.0及以上版本实例才支持自定义端口，Redis3.0实例不支持。 创建Redis实例，如果没发送该参数或该参数为空，表示实例使用默认端口6379。如果自定义端口，端口范围为1~65535的任意数字。 |
|
rename_commands |
Object |
否 |
支持自定义重命名高危命令。只有创建Redis4.0及以上版本实例才支持重命名高危命令，Redis3.0不支持。 创建Redis实例，如果没发送该参数或该参数为空，表示没有需要重命名的命令。当前支持重命名的高危命令有command、keys、flushdb、flushall、hgetall、scan、hscan、sscan、和zscan，其他命令暂不支持重命名。 |
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
save_days |
Integer |
否 |
当backup_type设置为manual时，该参数为必填。 保留天数，单位：天，取值范围：1-7。 |
|
backup_type |
String |
否 |
备份类型。
默认值是：manual。 |
|
periodical_backup_plan |
Object |
是 |
备份计划，具体请参考表4。 |
|
参数 |
类型 |
必选 |
说明 |
|---|---|---|---|
|
begin_at |
String |
是 |
备份执行时间，“00:00-01:00”代表0点开始执行备份。 |
|
period_type |
String |
是 |
备份周期类型，目前支持“weekly”。 |
|
backup_at |
Array |
是 |
每周的周几开始备份，取值1-7，1代表周一，7代表周日。 |
|
timezone_offset |
String |
否 |
备份的时区。取值为-1200 ~+1200之间的时区。若为空则默认使用DCS-Server节点的当前时区。 |
请求示例
- 请求URL：
POST https://{dcs_endpoint}/v1.0/{project_id}/instances
- 示例：
{ "name": "dcs-a11e", "description": "Create an instance", "engine": "Redis", "engine_version": "3.0", "capacity": 2, "spec_code": "XXXXXX", "password": "XXXXXX", "vpc_id": "27d99e17-42f2-4751-818f-5c8c6c03ff15", "security_group_id": "1477393a-29c9-4de5-843f-18ef51257c7e", "subnet_id": "ec2f34b9-20eb-4872-85bd-bea9fc943128", "available_zones": ["ae04cf9d61544df3806a3feeb401b204","d573142f24894ef3bd3664de068b44b0"], "product_id": "XXXXXX", "instance_backup_policy": { "save_days": 1, "backup_type": "auto", "periodical_backup_plan": { "begin_at": "00:00-01:00", "period_type": "weekly", "backup_at": [ 1, 2, 3, 4, 5, 6, 7 ] } }, "maintain_begin": "22:00:00", "maintain_end": "02:00:00" }
响应消息
响应参数
响应示例
{
"instances": [
{
"instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f",
"instance_name": "dcs-demo"
}
],
"instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f"
}
