云数据库 MySQL 修改云数据库实例的IP和端口号-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口(ModifyDBInstanceVipVport)用于修改云数据库实例的IP和端口号，也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyDBInstanceVipVport。
Version	是	String	公共参数，本接口取值：2017-03-20。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例 ID，格式如：cdb-c1nl9rpv 或者 cdbro-c2nl9rpv 或者 cdbrg-c3nl9rpv，与云数据库控制台页面中显示的实例 ID 相同，可使用查询实例列表接口获取，其值为输出参数中字段 InstanceId 的值。示例值：cdb-f35wr6wj
DstIp	否	String	目标 IP。该参数和 DstPort 参数，两者必传一个。示例值：10.0.1.1
DstPort	否	Integer	目标端口，支持范围为：[1024-65535]。该参数和 DstIp 参数，两者必传一个。示例值：1025
UniqVpcId	否	String	私有网络统一 ID。示例值：11357
UniqSubnetId	否	String	子网统一 ID。示例值：23789
ReleaseDuration	否	Integer	进行基础网络转 VPC 网络和 VPC 网络下的子网变更时，原网络中旧IP的回收时间，单位为小时，取值范围为0-168，默认值为24小时。示例值：12
OpResourceId	否	String	变更集群版实例只读组时，InstanceId传实例id，需要额外指定该参数表示操作只读组。如果操作读写节点则不需指定该参数。示例值：cdb-xxx\|readonly

3. 输出参数

参数名称	类型	描述
AsyncRequestId	String	异步任务ID。(该返回字段目前已废弃) 注意：此字段可能返回 null，表示取不到有效值。示例值：d2baf2fb-cbae62df-7dd0d736-9cbd3e31
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改云数据库实例的IP和端口号

输入示例

https://cdb.tencentcloudapi.com/?Action=ModifyDBInstanceVipVport
&InstanceId=cdb-f35wr6wj
&DstIp=10.0.1.1
&DstPort=1025
&UniqVpcId=11357
&UniqSubnetId=23789
&ReleaseDuration=12
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "AsyncRequestId": "d2baf2fb-cbae62df-7dd0d736-9cbd3e31"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation.StatusConflict	任务状态冲突。
InternalError.JSONError	json解析失败。
InternalError.NetworkError	网络错误。
InternalError.VpcError	私有网络或子网错误。
InvalidParameter	参数错误。
InvalidParameter.InvalidParameterError	无效的参数值。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
OperationDenied	操作被拒绝。

修改云数据库实例的IP和端口号

本页目录：