API 中心
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>API 中心>云数据库 Redis®>实例相关接口>创建Redis实例

创建Redis实例

最近更新时间：2024-10-23 01:29:24

我的收藏

本页目录：

1. 接口描述

接口请求域名： redis.tencentcloudapi.com 。

本接口（CreateInstances）用于创建 Redis 实例。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateInstances。
Version 是 String 公共参数，本接口取值：2018-04-12。
Region 是 String 公共参数，详见产品支持的 地域列表。
TypeId 是 Integer 实例类型。
  • 2：Redis 2.8 内存版（标准架构）。
  • 3：CKV 3.2 内存版（标准架构）。
  • 4：CKV 3.2 内存版（集群架构）。
  • 6：Redis 4.0 内存版（标准架构）。
  • 7：Redis 4.0 内存版（集群架构）。
  • 8：Redis 5.0 内存版（标准架构）。
  • 9：Redis 5.0 内存版（集群架构）。
  • 15：Redis 6.2 内存版（标准架构）。
  • 16：Redis 6.2 内存版（集群架构）。
  • 17：Redis 7.0 内存版（标准架构）。
  • 18：Redis 7.0 内存版（集群架构）。

示例值：6
MemSize 是 Integer 内存容量，单位为MB， 数值需为1024的整数倍。具体规格，请通过 DescribeProductInfo 接口查询全地域的售卖规格。
- TypeId为标准架构时，MemSize是实例总内存容量；
- TypeId为集群架构时，MemSize是单分片内存容量。
示例值：4096
GoodsNum 是 Integer 实例数量，单次购买实例数量。具体信息，请通过 DescribeProductInfo 接口查询全地域的售卖规格。
示例值：1
Period 是 Integer 购买实例的时长。
- 若 BillingMode为1，即计费方式为包年包月时，需设置该参数，指定所购买实例的时长。单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
- 若 BillingMode为0，即计费方式为按量计费时，该参数配置为1。
示例值：1
BillingMode 是 Integer 计费方式。
- 0：按量计费。
- 1：包年包月。
示例值：0
ZoneId 否 Integer 实例所属的可用区ID，可参考地域和可用区 。
示例值：100002
Password 否 String 访问实例的密码。
- 当输入参数NoAuth为true时，指设置实例为免密码访问，Password可不用配置，否则Password为必填参数。
- 当实例类型TypeId为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.0内存版标准架构或集群架构时，其密码复杂度要求为：8-30个字符，至少包含小写字母、大写字母、数字和字符()`~!@#$%^&-+=_|{}[]:;<>,.?/ 中的2种，不能以"/"开头。
- 当实例类型*TypeId**为CKV 3.2 内存版标准架构或集群架构时，其密码复杂度为：8-30个字符，必须包含字母和数字，且 不包含其他字符。
示例值：123456MyP@ssword
VpcId 否 String 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 私有网络控制台查询具体的ID。
示例值：vpc-pxyzim13
SubnetId 否 String 私有网络VPC的子网。基础网络下， 该参数无需配置。请登录 私有网络控制台查询子网列表获取具体的 ID。
示例值：subnet-7jbabche
ProjectId 否 Integer 项目 ID。请登录Redis控制台，在右上角的账户信息菜单中，选择项目管理查询项目 ID。
示例值：0
AutoRenew 否 Integer 自动续费标识。
- 0：默认状态（手动续费）。
- 1：自动续费。
- 2：到期不续费。
示例值：0
SecurityGroupIdList.N 否 Array of String 安全组 ID 数组。
- 安全组是一种虚拟防火墙，对云数据库实例的网络访问进行控制。创建实例时，建议绑定相应的安全组。
- 请通过 DescribeInstanceSecurityGroup 接口获取实例的安全组 ID。
示例值：["sg-bmadczm1"]
VPort 否 Integer 用户自定义的网络端口。默认为6379，范围为 [1024,65535]。
示例值：6378
RedisShardNum 否 Integer 实例分片数量。
- 标准版实例无需配置该参数。
- 集群版实例，分片数量范围为：[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
示例值：1
RedisReplicasNum 否 Integer 实例副本数量。
- Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。
- Redis 2.8标准版、CKV标准版只支持1副本。
示例值：1
ReplicasReadonly 否 Boolean 标识实例是否需支持副本只读。
- Redis 2.8 标准版、CKV标准版不支持副本只读。
- 开启副本只读，实例将自动读写分离，写请求路由到主节点，读请求路由到副本节点。
- 如需开启副本只读，建议副本数量大于等于2。
示例值：true
InstanceName 否 String 实例名称。命名要求：仅支持长度小于60的中文、英文或者数字，短划线"-"、下划线"_"。
示例值：MyInstanceName
NoAuth 否 Boolean 配置实例是否支持免密码访问。
- true：免密访问实例。
- false：非免密访问实例。默认为非免密方式，仅VPC网络的实例支持免密码访问。
示例值：false
NodeSet.N 否 Array of RedisNodeInfo 实例的节点信息，包含节点 ID、节点类型、节点可用区 ID等。具体信息，请参见RedisNodeInfo 。
目前支持传入节点的类型（主节点或者副本节点），节点的可用区。单可用区部署不需要传递此参数。
ResourceTags.N 否 Array of ResourceTag 给实例设定标签。
ZoneName 否 String 指定实例所属的可用区名称。具体信息，请参见地域和可用区 。
示例值：ap-guangzhou
TemplateId 否 String 指定实例相关的参数模板 ID。
- 若不配置该参数，则系统会依据所选择的兼容版本及架构，自动适配对应的默认模板。
- 请通过DescribeParamTemplates接口，查询实例的参数模板列表，获取模板 ID 编号。
示例值：crs-cfg-rhlppeye
DryRun 否 Boolean 内部参数，标识创建实例是否需要检查。
- false ：默认值。发送正常请求，通过检查后直接创建实例。
- true：发送检查请求，不会创建实例。
示例值：true
ProductVersion 否 String 指定实例的产品版本。
- local：本地盘版。
- cloud：云盘版，
- cdc：独享集群版。如果不传默认发货为本地盘版本。
示例值：cdc
RedisClusterId 否 String 独享集群 ID。当ProductVersion设置为cdc时，该参数必须设置。
示例值：crs-cdc-0xigvn3t
AlarmPolicyList.N 否 Array of String 告警策略 ID 数组。

- 请登录腾讯云可观测平台-告警管理-策略管理获取告警策略 ID。
- 若不配置该参数，则绑定默认告警策略。默认告警策略具体信息，请登录腾讯云可观测平台-告警管理-策略管理查看。
示例值：["policy-6e6wodv4"]

3. 输出参数

参数名称 类型 描述
DealId String 交易的ID。
示例值：199878234
InstanceIds Array of String 实例ID。
示例值：crs-3sz5wdav
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例一

购买包年包月的Redis5.0内存版（集群架构）实例

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>

{
    "TypeId": "9",
    "VpcId": "vpc-fmh*****",
    "GoodsNum": "1",
    "RedisShardNum": "3",
    "Period": "3",
    "BillingMode": "1",
    "NoAuth": "true",
    "MemSize": "2048",
    "SubnetId": "subnet-680c****",
    "RedisReplicasNum": "1",
    "ZoneId": "200002"
}

输出示例

{
    "Response": {
        "DealId": "154494263",
        "InstanceIds": [
            "crs-h9sn****"
        ],
        "RequestId": "d39baee1-e34f-4685-a810-5d27c510acb3"
    }
}

示例2 请求示例二

购买按量计费的Redis4.0内存版（标准架构）实例

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInstances
<公共请求参数>

{
    "TypeId": "6",
    "Password": "**********",
    "GoodsNum": "1",
    "Period": "1",
    "BillingMode": "0",
    "MemSize": "1024",
    "ZoneId": "100002"
}

输出示例

{
    "Response": {
        "RequestId": "2a836c00-175f-11eb-aeb3-db134c8d8fec",
        "InstanceIds": [
            "crs-kic39axx"
        ],
        "DealId": "22716"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.PayFailed 支付失败。
FailedOperation.SystemError 内部系统错误，和业务无关。
FailedOperation.Unknown weekday输入无效数据。
InternalError.InternalError 内部错误。
InvalidParameter.EmptyParam 参数为空。
InvalidParameter.OnlyVPCOnSpecZoneId 上海金融只提供vpc网络。
InvalidParameter.PermissionDenied 接口没有cam权限。
InvalidParameterValue.BaseNetWorkAccessDeny 不是vpc网络下实例。
InvalidParameterValue.InvalidInstanceTypeId 请求购买的实例类型错误（TypeId 1:集群版；2:主从版,即原主从版)。
InvalidParameterValue.InvalidSubnetId vpc网络下，vpcid 子网id 非法。
InvalidParameterValue.PasswordEmpty 密码为空。
InvalidParameterValue.PasswordFreeDenied 腾讯集团内部账号禁止使用免密实例。
InvalidParameterValue.PasswordRuleError 设置密码时，MC 传入的 old password 与先前设定密码不同。
InvalidParameterValue.SecurityGroupIdsNotExists 请求参数错误，安全组id错误。
InvalidParameterValue.UnVpcIdNotExists vpc网络下，uniqVpcId 子网id 非法。
LimitExceeded 超过配额限制。
LimitExceeded.InvalidMemSize 请求的容量不在售卖规格中（memSize应为1024的整数倍，单位：MB）。
LimitExceeded.InvalidParameterGoodsNumNotInRange 一次请求购买的实例数不在售卖数量限制范围内。
LimitExceeded.PeriodExceedMaxLimit 购买时长超过3年,请求时长超过最大时长。
LimitExceeded.PeriodLessThanMinLimit 购买时长非法，时长最少1个月。
ResourceInsufficient 资源不足。
ResourceNotFound.AccountDoesNotExists uin 值为空。
ResourceNotFound.InstanceNotExists 根据 serialId 没有找到对应 redis。
ResourceUnavailable.InstanceDeleted 实例已经被回收了。
ResourceUnavailable.NoEnoughVipInVPC vpc网络IP资源不足。
ResourceUnavailable.NoRedisService 请求的区域暂时不提供redis服务。
ResourceUnavailable.NoTypeIdRedisService 请求的区域暂时不提供请求类型的redis服务。
ResourceUnavailable.SaleOut 地域对应类型已售罄。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnauthorizedOperation.UserNotInWhiteList 用户不在白名单中。
UnsupportedOperation 操作不支持。
中国站
文档反馈
文档活动
message-icon联系我们
目录