Contents：
1. API Description
Domain name for API request: cdb.tencentcloudapi.com.
This API (ModifyDBInstanceVipVport) is used to modify the IP and the port number of a database instance, to switch basic network to VPC network, and to change subnets under VPC network.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: ModifyDBInstanceVipVport |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-20 |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page and can be obtained via API Query Instance List. Its value equals the InstanceId field value in the output parameters. |
| DstIp | No | String | Destination IP. Either DstIp or DstPort must be specified. |
| DstPort | No | Integer | Destination port. Supported range: [1024-65535]. Either DstPort or DstIp must be specified. |
| UniqVpcId | No | String | Unified ID of VPC network. |
| UniqSubnetId | No | String | Unified subnet ID. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| AsyncRequestId | String | Asynchronous task ID. You can query the execution status of the task using the API Query task list. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Error Codes
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter | Parameter error. |
5. Example
Example 1 Modify the IP and the port number of a database instance
Input example
https://cdb.tencentcloudapi.com/?Action=ModifyDBInstanceVipVport
&InstanceId=cdb-f35wr6wj
&DstIp=10.0.1.1
&DstPort=1025
&VpcId=11357
&SubnetId=23789
&<Common request parameters>Output example
{
"Response": {
"AsyncRequestId": "d2baf2fb-cbae62df-7dd0d736-9cbd3e31",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.
