tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyInstanceVip

Last updated: 2024-07-19 14:30:10

    1. API Description

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

    This API is used to modify instance VIP.

    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: ModifyInstanceVip.
    Version Yes String Common Params. The value used for this API: 2018-04-11.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID
    Vip Yes String Instance VIP
    Ipv6Flag No Integer IPv6 flag
    VipReleaseDelay No Integer VIP retention period in hours. Value range: 0-168. Default value: 24. 0 indicates that the VIP will be released immediately, but there will be 1-minute delay.

    3. Output Parameters

    Parameter Name Type Description
    FlowId Integer Async task flow 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 None

    Input Example

    https://dcdb.tencentcloudapi.com/?Action=ModifyInstanceVip
&InstanceId=tdsql-jv8z8fhl
&VipReleaseDelay=168
&Vip=10.0.0.2
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "14f6980a-7fe1-11ea-b896-525400542aa6",
        "FlowId": 1122
    }
}

    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.ApplyVipFailed Failed to apply for VIP
    FailedOperation.VipNotChange VIP can’t be the same.
    InternalError.DbOperationFailed Failed to query the database.
    InternalError.InnerSystemError Internal system error.
    InvalidParameter Parameter error.
    InvalidParameter.VipNotInSubnet VIP is not in the subnet.
    InvalidParameter.VipUsed VIP is in use.
    ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
    UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy