tencent cloud

APIs

ModifyVipVport

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-10-28 10:17:43

1. API Description

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

This API is used to modify the ip and port of an instance group.

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: ModifyVipVport.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId Yes String Cluster ID.
InstanceGroupId No String Instance Group ID
Vip No String Destination ip that needs to be modified
Vport No Integer Destination port that needs to be modified
DbType No String Database type. Valid values:
  • MYSQL
  • OldIpReserveHours No Integer Retention time of the old ip before recycling. Unit: hour. 0 means reclaim immediately.

    3. Output Parameters

    Parameter Name Type Description
    FlowId Integer Asynchronous task ID.
    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 Modify the ip Port

    Input Example

    https://cynosdb.intl.tencentcloudapi.com/?Action=ModifyVipVport
    &ClusterId=cynosdbmysql-mwg7121e
    &InstanceGrpId=cynosdbmysql-grp-o48ssqs5
    &Vip=172.1.1.1
    &<Common request parameters>

    Output Example

    {
        "Response": {
            "RequestId": "a5706353-296a-4992-ad07-ac4a48eeba43",
            "FlowId": 134983
        }
    }

    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

    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.DatabaseAccessError Database access failed. Try again later. If the issue persists, contact customer service.
    FailedOperation.FlowCreateError Failed to create the process. Please retry later. If the issue continues, contact customer service.
    FailedOperation.OperationFailedError Operation failed. Try again later. If the issue persists, contact customer service.
    InternalError.SystemError Internal system error.
    InvalidParameterValue.InvalidParameterValueError Parameter value is invalid.
    InvalidParameterValue.ParamError Parameter error.
    ResourceNotFound.ClusterNotFoundError The cluster does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.

    ヘルプとサポート

    この記事はお役に立ちましたか?

    フィードバック