1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
本接口(ModifyInstanceAvailabilityZones)用于变更实例可用区
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyInstanceAvailabilityZones。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 指定实例 ID。例如:crs-xjhsdj****,请登录Redis控制台在实例列表复制实例 ID。 示例值:crs-65xie09x |
SwitchOption | 是 | Integer | 切换时间。 - 1:维护时间窗切换。 - 2:立即切换。 示例值:2 |
NodeSet.N | 是 | Array of RedisNodeInfo | 实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见RedisNodeInfo 。 单可用区实例无需传NodeId,多可用区实例NodeId必传 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 任务ID。 示例值:1924 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例1
更改多az实例可用区(时间窗口切换)
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyInstanceAvailabilityZones
<公共请求参数>
{
"InstanceId": "crs-rrhr1lm6",
"SwitchOption": 1,
"NodeSet": [
{
"NodeId": 339472,
"NodeType": 0,
"ZoneId": 100004
},
{
"NodeId": 339473,
"NodeType": 1,
"ZoneId": 100003
},
{
"NodeId": 339549,
"NodeType": 1,
"ZoneId": 100003
}
]
}
输出示例
{
"Response": {
"RequestId": "27c0d6e8-9894-42e0-a03b-814a204437ba",
"TaskId": 2031290200
}
}
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.Unknown | weekday输入无效数据。 |
InternalError.InternalError | 内部错误。 |
InvalidParameter.InvalidParameter | 业务参数错误。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |
InvalidParameterValue.CheckNotPass | 业务校验不通过。 |
InvalidParameterValue.UnSupportedType | 实例类型不支持。 |
LimitExceeded.ReplicationGroupLocked | 复制组已锁定。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound.InstanceNotExists | 根据 serialId 没有找到对应 redis。 |
ResourceUnavailable.InstanceStatusAbnormal | redis 状态异常,不能执行对应流程。 |
ResourceUnavailable.InstanceStatusError | 实例状态异常,不能执行对应操作。 |
UnsupportedOperation.InstanceNotOperation | 不支持当前操作。 |