ModifyDBInstanceVipVport

最后更新时间：2024-11-20 11:13:00

1. API Description

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

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

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

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: ModifyDBInstanceVipVport.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID in the format of cdb-c1nl9rpv, cdbro-c2nl9rpv, or cdbrg-c3nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the DescribeDBInstances API to query the ID, which is the value of the `InstanceId` output parameter.
DstIp	No	String	Target IP. Either this parameter or `DstPort` must be passed in.
DstPort	No	Integer	Target 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 classic network to VPC or changing the VPC subnet. Value range: 0–168. Default value: `24`.

3. Output Parameters

Parameter Name	Type	Description
AsyncRequestId	String	Async task ID. This parameter is deprecated. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying the IP and port number of a TencentDB instance

Input Example

https://cdb.intl.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

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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
AuthFailure	CAM signature/authentication error.
FailedOperation.StatusConflict	Task status conflict.
InternalError.JSONError	Failed to parse JSON.
InternalError.NetworkError	Network error
InternalError.VpcError	VPC or subnet error.
InvalidParameter	Parameter error.
InvalidParameter.InvalidParameterError	Invalid parameter value
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value
OperationDenied	Operation denied.

tencent cloud

Recent Pages