切换Redis实例的专有网络VPC或交换机,如果Redis实例为经典网络,则会将其切换为专有网络。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
kvstore:SwitchNetwork | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TargetNetworkType | string | 否 | 需要切换到的网络类型,取值固定为 VPC,即专有网络。 | VPC |
VpcId | string | 是 | 要切换到的目标专有网络 ID,可调用专有网络 VPC 的 DescribeVpcs 获取。 说明
| vpc-bp1nme44gek34slfc**** |
VSwitchId | string | 是 | 要切换到的目标专有网络下的虚拟交换机 ID,可调用专有网络 VPC 的 DescribeVpcs 获取。 说明
目标虚拟交换机所属的可用区需和 Redis 实例相同。
| vsw-bp1e7clcw529l773d**** |
InstanceId | string | 是 | 实例 ID,可调用 DescribeInstances 获取。 | r-bp1zxszhcgatnx**** |
RetainClassic | string | 否 | 如果实例当前为经典网络,将其切换至专有网络时,是否保留原经典网络连接地址,取值:
说明
当实例的网络类型为经典网络时,本参数才可用。
| True |
ClassicExpiredDays | string | 否 | 经典网络连接地址的保留时间,取值:14、30、60、120,单位为天。 说明
| 30 |
返回参数
示例
正常返回示例
JSON
格式
{
"TaskId": "578678678",
"RequestId": "F0997EE8-F4C2-4503-9168-85177ED78C70"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidToken.Malformed | The Specified parameter Token is not valid. | - |
400 | VpcServiceError | Invoke vpc service failed. | - |
400 | IzNotSupportVpcError | Specify iz not support vpc. | 指定 iz不支持Vpc。 |
400 | IzNotSupportSwitchNetworkError | Specify iz not support switch network. | 指定 iz不支持交换网络。 |
400 | VpcVerifyError | VpcId is wrong. | - |
400 | VpcAndVSwitchNotChange | VpcId and vSwitchId not change. | VpcId和vSwitchId未更改。 |
403 | ResourceAlreadyExists | Resource already exists. | - |
403 | InsufficientResourceCapacity | ip resource is conflict with other custins. | - |
403 | VpcFreePasswordNoSupport | The custins opend VPCFreePassword not support this operation. | 实例由于打开了VPC免密,暂不支持此操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2024-02-26 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-07-20 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|