tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ModifyVipVport

最后更新时间：2023-08-23 14:22:57

1. API Description

Domain name for API request: cynosdb.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.
ClusterId Yes String Cluster ID
InstanceGrpId Yes String Instance group ID
Vip No String Target IP to be modified
Vport No Integer Target port to be modified
DbType No String Database type. Valid values:
  • MYSQL
    • OldIpReserveHours No Integer Valid hours of old IPs. If it is set to 0 hours, the IPs will be released immediately.

    3. Output Parameters

    Parameter Name Type Description
    FlowId Integer Async task ID
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Modifying an IP port

    Input Example

    https://cynosdb.tencentcloudapi.com/?Action=ModifyVipVport
&ClusterId=xxx
&InstanceGrpId=xxx
&Vip=xx.xx.xx.xx
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "128046",
        "FlowId": "123"
    }
}

    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 Failed to access the database. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.FlowCreateError Failed to create a task. Try again later. If the problem persists, contact customer service.
    FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
    InternalError.SystemError Internal system error.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
    InvalidParameterValue.ParamError Incorrect parameter.
    ResourceNotFound.ClusterNotFoundError The cluster does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款