创建复制组接口

最近更新时间:2024-05-30 02:03:02

我的收藏

1. 接口描述

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

该接口(CreateReplicationGroup)用于创建复制组。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateReplicationGroup。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定复制组中的主实例ID。
示例值:crs-dvchdv5
GroupName String 复制组名称。名称只支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。
示例值:test
Remark String 备注信息。
示例值:Create a Replication Group Test

3. 输出参数

参数名称 类型 描述
TaskId Integer 异步流程ID。
示例值:486489
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

创建复制组实例

输入示例

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

{
    "InstanceId": "crs-5qlr****",
    "GroupName": "name"
}

输出示例

{
    "Response": {
        "TaskId": 327,
        "RequestId": "e546784b-709c-401d-aba6-73037eb4e522"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
FailedOperation.UnSupportError 实例不支持该接口。
InternalError.DbOperationFailed 统一的 DB 操作错误,可以是 update insert select..。
InvalidParameterValue.CheckNotPass 业务校验不通过。
InvalidParameterValue.InstanceNameRuleError 重命名,命名规则错误。
InvalidParameterValue.NotRepeatBind 实例不能重复绑定。
InvalidParameterValue.ReplicationGroupNotExists 复制组不存在。
InvalidParameterValue.SpecNotExist 实例规格不存在。
InvalidParameterValue.UnSupportedType 实例类型不支持。
LimitExceeded.InstanceNotEmpty 绑定实例必须为空。
ResourceNotFound.InstanceNotExists 根据 serialId 没有找到对应 redis。
ResourceUnavailable.InstanceStatusError 实例状态异常,不能执行对应操作。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnsupportedOperation.LimitProxyVersion 实例版本过低。