1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
本接口(CloneInstances)用于基于当前实例的备份文件克隆一个完整的新实例。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CloneInstances。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 指定待克隆的源实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。 示例值:crs-xxx |
GoodsNum | 是 | Integer | 单次克隆实例的数量。 - 包年包月每次购买最大数量为100。 - 按量计费每次购买最大数量为30。 示例值:1 |
ZoneId | 是 | Integer | 克隆实例所属的可用区ID。当前所支持的可用区 ID,请参见地域和可用区 。 示例值:100001 |
BillingMode | 是 | Integer | 付费方式。
示例值:0 |
Period | 是 | Integer | 购买实例时长。
示例值:1 |
SecurityGroupIdList.N | 是 | Array of String | 安全组ID。请登录控制台,在安全组页面获取安全组 ID 信息。 示例值:["sg-bmadczm1"] |
BackupId | 是 | String | 克隆实例使用的备份ID。请通过接口DescribeInstanceBackups获取备份ID。 示例值:154572601-1165734322-153731238 |
NoAuth | 否 | Boolean | 配置克隆实例是否支持免密访问。开启 SSL 与外网均不支持免密访问。
示例值:false |
VpcId | 否 | String | 配置克隆实例的私有网络ID。如果未配置该参数,默认选择基础网络。 示例值:vpc-pxyzim13 |
SubnetId | 否 | String | 配置克隆实例所属私有网络的子网。基础网络时该参数无需配置。 示例值:subnet-7jbabche |
InstanceName | 否 | String | 克隆实例的名称。 仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。 示例值:MyInstanceName |
Password | 否 | String | 克隆实例的访问密码。
示例值:123456MyP@ssword |
AutoRenew | 否 | Integer | 自动续费标识。
示例值:9 |
VPort | 否 | Integer | 用户自定义的端口,默认为6379,取值范围[1024,65535]。 示例值:6378 |
NodeSet.N | 否 | Array of RedisNodeInfo | 实例的节点信息。
|
ProjectId | 否 | Integer | 项目 ID。登录Redis 控制台,可在右上角的账号中心 > 项目管理中查找项目ID。 示例值:0 |
ResourceTags.N | 否 | Array of ResourceTag | 克隆实例需绑定的标签。 |
TemplateId | 否 | String | 指定克隆实例相关的参数模板 ID。 - 若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。 - 请通过DescribeParamTemplates接口,查询实例的参数模板列表,获取模板 ID 编号。 示例值:crs-cfg-rhlppeye |
AlarmPolicyList.N | 否 | Array of String | 指定克隆实例的告警策略 ID。请登录腾讯云可观测平台控制台,在 告警管理 > 策略管理页面获取策略 ID 信息。 示例值:policy-ny3vfcp0 |
CloneTime | 否 | String | 克隆指定恢复数据的时间。 仅支持已开通秒级备份的实例 示例值:2006-01-02 15:04:05 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DealId | String | 请求任务 ID。 示例值:199878234 |
InstanceIds | Array of String | 克隆实例的 ID。 示例值:["crs-3sz5wdav"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
克隆实例
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloneInstances
<公共请求参数>
{
"InstanceId": "abc",
"GoodsNum": 1,
"NoAuth": true,
"VpcId": "abc",
"SubnetId": "abc",
"ZoneId": 1,
"InstanceName": "abc",
"BillingMode": 0,
"Period": 1,
"Password": "abc",
"AutoRenew": 1,
"SecurityGroupIdList": [
"abc"
],
"VPort": 1,
"BackupId": "abc",
"NodeSet": [
{
"NodeId": 0,
"NodeType": 0,
"ZoneId": 1,
"ZoneName": "abc"
}
],
"ProjectId": 0,
"ResourceTags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"TemplateId": "abc",
"AlarmPolicyList": [
"abc"
]
}
输出示例
{
"Response": {
"RequestId": "2a836c00-175f-11eb-aeb3-db134c8d8fec",
"InstanceIds": [
"crs-kic3****"
],
"DealId": "22716"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.PayFailed | 支付失败。 |
FailedOperation.SystemError | 内部系统错误,和业务无关。 |
FailedOperation.Unknown | weekday输入无效数据。 |
InternalError.InternalError | 内部错误。 |
InvalidParameter.EmptyParam | 参数为空。 |
InvalidParameter.OnlyVPCOnSpecZoneId | 上海金融只提供vpc网络。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |
InvalidParameterValue.BaseNetWorkAccessDeny | 不是vpc网络下实例。 |
InvalidParameterValue.CheckNotPass | 业务校验不通过。 |
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.PeriodLessThanMinLimit | 购买时长非法,时长最少1个月。 |
LimitExceeded.ReachTheAmountLimit | 请求的 redis 数量超过最大/最小购买数限制。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound.AccountDoesNotExists | uin 值为空。 |
ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
ResourceUnavailable.InstanceDeleted | 实例已经被回收了。 |
ResourceUnavailable.NoEnoughVipInVPC | vpc网络IP资源不足。 |
ResourceUnavailable.NoRedisService | 请求的区域暂时不提供redis服务。 |
ResourceUnavailable.NoServiceAvailableForThisZoneId | 请求的 zoneId 不提供 redis服务。 |
ResourceUnavailable.SaleOut | 地域对应类型已售罄。 |
UnauthorizedOperation.NoCAMAuthed | 无cam 权限。 |
UnauthorizedOperation.UserNotInWhiteList | 用户不在白名单中。 |
UnsupportedOperation | 操作不支持。 |