Bind a CVM in a VPC with a VIP

Last updated: 2020-06-04 17:10:33

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new VPC API 3.0 which is standardized and faster.

    1. API Description

    This API (AssociateVip) is used to bind VPC CVMs with a VIP, that is, to bind a preassigned private VIP to the specified CVMs to produce the master and slave servers.

    We do not recommend using this API because its functions can be replaced by ENIs.

    API request domain name: vpc.api.qcloud.com

    (1) Contact online customer service to apply for a VIP.
    (2) The CVMs must be in a VPC.

    2. Input Parameters

    Below is a list of API request parameters. You need to add common request parameters to your request when calling this API. For more information, see the Common Request Parameters page. The Action field for this API is AssociateVip.

    Parameter name Required Type Description
    vpcId Yes String VPC ID assigned by the system, for example: vpc-2ari9m7h. Both the vpcId before upgrade and the upgraded unVpcId are supported.
    vipId Yes Int VIP ID, for example: 12. You need to contact the online customer service to apply for a VIP ID.
    lanIp Yes String Private IP address of the CVM, for example: 10.0.0.1. For more information about querying CVM IP addresses, see View the List of Instances.

    3. Output Parameters

    Parameter name Type Description
    code Int Common error code. 0: Successful; other values: Failed. For more information, see Common Error Codes.
    message String Module error message, which depends on the API.

    4. Error Codes

    The following error codes only include business logic error codes for this API.

    Error code Description
    InvalidVipId.NotFound The vipId does not exist. This error code indicates that the VIP needs to be assigned manually. If you forget your vipId or you are trying to bind for the first time, contact the online customer service to retrieve your vipId or apply for a new one.
    InvalidLanIp.NotFound The CVM does not exist. In this case, verify that the lanIp that you entered is correct. To query the CVMs under the VPC, see View the List of CVM Instances.
    InvalidVpc.NotFound Invalid VPC. This error code indicates that the VPC resource does not exist. In this case, verify whether the resource information that you entered is correct.

    5. Sample

    Input

    
      https://vpc.api.qcloud.com/v2/index.php?Action=AssociateVip
        &<Common Request Parameters>
      &vpcId=vpc-2ari9m7h
        &vipId=1
        &lanIp=10.0.0.2
    

    Output

    
    {
        "code": 0,
        "message": ""
    }
    

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help