云数据库 KeeWiDB 修改实例网络配置

1. 接口描述

接口请求域名： keewidb.tencentcloudapi.com 。

本接口（ModifyNetworkConfig）用于修改实例网络配置。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyNetworkConfig。
Version	是	String	公共参数，本接口取值：2022-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID，如：kee-6ubh****。示例值：kee-6ubhgouj
Operation	是	String	操作类型。 changeVip：修改实例私有网络。 changeVpc：修改实例私有网络所属子网。 changeBaseToVpc：基础网络转为私有网络。示例值：changeVip
Vip	否	String	修改后的 VIP 地址。当参数Operation为changeVip时，需设置实例修改后的 VIP 地址。该参数不配置，则自动分配。示例值：10.1.1.2
VpcId	否	String	修改后的私有网络 ID。当参数Operation为changeVip或者为changeBaseToVpc时，务必设置实例修改后的私有网络 ID。示例值：vpc-hu6khgap
SubnetId	否	String	修改后的所属子网 ID。当参数Operation为changeVpc或者为changeBaseToVpc时，务必设置实例修改后的子网 ID。示例值：subnet-6mt7lir6
Recycle	否	Integer	原 VIP 保留时长。单位：天。取值范围：0、1、2、3、7、15。示例值：7

3. 输出参数

参数名称	类型	描述
Status	Boolean	执行状态。 true：执行成功。 false：执行失败。示例值：true
SubnetId	String	修改后的子网 ID。示例值：subnet-6mt7lir6
VpcId	String	修改后的私有网络 ID。示例值：vpc-hu6khgap
Vip	String	修改后的 VIP 地址。示例值：10.2.3.8
TaskId	Integer	任务ID。示例值：780012085
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

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

{
    "InstanceId": "kee-9clk****",
    "Operation": "changeVip"
}

输出示例

{
    "Response": {
        "RequestId": "929c9b9f-e451-4413-af27-045e4ad8a0d7",
        "Status": true,
        "SubnetId": "subnet-lknn****",
        "Vip": "10.0.16.44",
        "VpcId": "vpc-hqy2****"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.SystemError	内部系统错误，和业务无关。
FailedOperation.Unknown	未知类型操作错误。
InternalError.DbOperationFailed	统一的 DB 操作错误，可以是 update insert select..。
InternalError.InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.PermissionDenied	接口没有cam权限。
ResourceUnavailable.InstanceDeleted	实例已经被回收了。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.UserNotInWhiteList	用户不在白名单中。

修改实例网络配置

本页目录：