1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口（ModifyDBInstanceNetwork）用于修改运行中实例的网络，仅支持从VPC网络到VPC网络的转换
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyDBInstanceNetwork。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例id 示例值：mssql-p2yli7gv |
| NewVpcId | 是 | String | 新VPC网络Id 示例值：vpc-ilki4qdp |
| NewSubnetId | 是 | String | 新子网Id 示例值：subnet-lru6dhh8 |
| OldIpRetainTime | 否 | Integer | 原vip保留时长，单位小时，默认为0，代表立即回收，最大为168小时 示例值：12 |
| Vip | 否 | String | 指定VIP地址 示例值：127.0.0.1 |
| DRNetwork | 否 | Integer | 目标节点，0-修改主节点网络，1-修改备节点网络，默认取值0 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | Integer | 实例转网流程id，可通过DescribeFlowStatus接口查询流程状态 示例值：100125 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 转网
输入示例
POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceNetwork
<公共请求参数>
{
"InstanceId": "mssql-e720ieef",
"NewVpcId": "vpc-kw88teud",
"NewSubnetId": "subnet-8z5n8tcg",
"OldIpRetainTime": "0"
}输出示例
{
"Response": {
"FlowId": 1011581,
"RequestId": "bdac237c-b9b7-4050-9284-97898cca5883"
}
}示例2 修改实例网络
输入示例
https://sqlserver.tencentcloudapi.com/?Action=ModifyDBInstanceNetwork
&InstanceId=mssql-p2yli7gv
&NewVpcId=vpc-ilki4qdp
&NewSubnetId=subnet-lru6dhh8
&Vip=127.0.0.1
&OldIpRetainTime=12
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "20db6661-2a85-49d9-8a37-976b931649fb",
"FlowId": 100125
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.DBError | 数据库错误。 |
| FailedOperation.GcsError | 操作失败或者网络超时。 |
| FailedOperation.GetVpcFailed | 获取VPC网络信息失败。 |
| FailedOperation.VPCError | 操作网络失败或者超时。 |
| InternalError.CamAuthFailed | CAM鉴权请求失败。 |
| InternalError.CreateFlowFailed | 流程创建失败。 |
| InternalError.DBConnectError | 数据库连接错误。 |
| InternalError.SystemError | 系统错误。 |
| InternalError.UnknownError | 未知错误。 |
| InternalError.VPCError | VPC错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InputIllegal | 输入错误。 |
| InvalidParameter.ParamsAssertFailed | 参数断言转换错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| ResourceNotFound.VpcNotExist | VPC网络不存在。 |
| ResourceUnavailable.InstanceStatusInvalid | 实例状态无效。 |
| ResourceUnavailable.VpcNotExist | VPC不存在。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation.NotSupportRepeat | 不支持重复操作。 |
