1. 接口描述
接口请求域名： redis.tencentcloudapi.com 。
该接口（ChangeMasterInstance）用于将复制组内只读实例设置为主实例。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChangeMasterInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GroupId | 是 | String | 复制组ID。创建复制组时，系统自动分配的 ID，是复制组的唯一标识。例如：crs-rpl-m3zt****，请登录Redis 控制台的全球复制组列表获取复制组 ID。 示例值：crs-rpl-deindi7de |
| InstanceId | 是 | String | 指定待提升为主实例的只读实例 ID。例如：crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。 示例值：crs-deindi7de |
| ForceSwitch | 否 | Boolean | 标识是否强制提主。 - true：强制提主。 - false：不强制提主。 示例值：true |
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: ChangeMasterInstance
<公共请求参数>
{
"InstanceId": "crs-sa5****",
"GroupId": "crs-rpl-sa5****",
"ForceSwitch": false
}输出示例
{
"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。
- 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.SystemError | 内部系统错误，和业务无关。 |
| FailedOperation.UnSupportError | 实例不支持该接口。 |
| InternalError.DbOperationFailed | 统一的 DB 操作错误，可以是 update insert select..。 |
| InvalidParameter.PermissionDenied | 接口没有cam权限。 |
| InvalidParameterValue.CheckNotPass | 业务校验不通过。 |
| InvalidParameterValue.ReplicationGroupNotExists | 复制组不存在。 |
| LimitExceeded.ReplicationGroupLocked | 复制组已锁定。 |
| ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
| ResourceUnavailable.InstanceStatusError | 实例状态异常，不能执行对应操作。 |
| UnsupportedOperation.Inspection | 复制组巡检中。 |
| UnsupportedOperation.InstanceNotOperation | 不支持当前操作。 |
