Help & DocumentationTencentDB for MySQLAPI DocumentsInstance APIsModifyDBInstanceVipVport

ModifyDBInstanceVipVport

Last updated: 2020-04-23 18:53:08

PDF

Contents：

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API (ModifyDBInstanceVipVport) is used to modify the IP and port number of a TencentDB instance, switch from the basic network to VPC, or change VPC subnets.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, 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 in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the instance list querying API to query the ID, whose value is the InstanceId value in output parameters.
DstIp No String Destination IP. Either this parameter or DstPort must be passed in.
DstPort No Integer Destination port number. Value range: [1024-65535]. Either this parameter or DstIp must be passed in.
UniqVpcId No String Unified VPC ID
UniqSubnetId No String Unified subnet ID.
ReleaseDuration No Integer Repossession duration in hours for old IP in the original network when changing from the basic network to VPC or changing the VPC subnet. Value range: 0–168 hours. Default value: 24 hours.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task ID. (This returned field has been disused)
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying the IP and port number of TencentDB instance

Input Example

https://cdb.tencentcloudapi.com/?Action=ModifyDBInstanceVipVport
&InstanceId=cdb-f35wr6wj
&DstIp=10.0.1.1
&DstPort=1025
&UniqVpcId=11357
&UniqSubnetId=23789
&ReleaseDuration=12
&<Common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.StatusConflict Task status conflict.
InvalidParameter Parameter error.