1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
本接口(ModifyDBInstanceNetworkAddress)用于修改云数据库实例的网络信息,支持基础网络切换为私有网络、私有网络切换私有网络。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyDBInstanceNetworkAddress。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 指定需修改网络的实例 ID。例如:cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。 示例值:cmgo-7pjedvz7 |
OldIpExpiredTime | 是 | Integer | 原 IP 地址保留时长。 - 单位为分钟,0表示立即回收原 IP 地址。 - 原 IP 将在约定时间后释放,在释放前原 IP和新 IP均可访问。 示例值:1 |
NewUniqVpcId | 是 | String | 切换后的私有网络 ID,若实例当前为基础网络,该字段无需配置。 示例值:vpc-**** |
NewUniqSubnetId | 是 | String | 切换私有网络的子网 ID。若实例当前为基础网络,该字段无需配置。 示例值:subnet-**** |
NetworkAddresses.N | 否 | Array of ModifyNetworkAddress | IP 地址信息,包含新 IP 地址与 原 IP 地址。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowId | Integer | 修改网络异步流程任务ID。 示例值:1679402995 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改云数据库实例网络信息
修改云数据库实例的VIP信息
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceNetworkAddress
<公共请求参数>
{
"InstanceId": "cmgo-9d0p****",
"OldIpExpiredTime": 1,
"NetworkAddresses": [
{
"NewIPAddress": "10.0.0.10",
"OldIpAddress": "10.0.0.1"
}
],
"NewUniqVpcId": "vpc-gfb3pqo1",
"NewUniqSubnetId": "ins-wsdn61fw"
}
输出示例
{
"Response": {
"FlowId": 1679402995,
"RequestId": "8279f6c2-db93-4b2e-931b-233d780b1a91"
}
}
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.NotAllowModifyAddrAfterOpenWanService | 当前实例已开启外网访问。 |
InternalError | 内部错误。 |
InternalError.CheckAppIdFailed | appId校验失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidVip | 无效Vip信息。 |
InvalidParameterValue.StatusAbnormal | 实例处于不允许操作的状态。 |
InvalidParameterValue.VpcIdOrSubnetIdNotFound | 未找到虚拟网络(子网)。 |