Query EIP Quota

Last updated: 2020-06-08 10:58:40

    Note:

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

    1. API Description

    Domain name: eip.api.qcloud.com
    API name: DescribeEipQuota

    This API is used to query the quota on EIPs for a specified region.

    2. Input Parameters

    Parameter Name Required Type Description
    null - - -

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code. A value of 0 indicates success, and other values indicate failure. For more information, refer to Common Error Codes on Error Code page.
    message String Module error message description depending on API. For more information, refer to Module Error Codes on Error Code page.
    data Array Returned data structure

    Data structure

    Parameter Name Type Description
    data.eipNumQuota Int Total quota on the number of EIPs that can be requested.
    data.currentEipNum Int Current number of EIPs
    data.dailyApplyQuota Int Daily quota on the number of requests for EIPs
    data.dailyApplyCount Int Number of requests for EIPs on current day
    data.dailyAllocWanIpQuota Int Daily quota on the operations to reallocate an ordinary public IP when an EIP is unbound
    data.dailyAllocWanIpCount Int Number of operations to reallocate an ordinary public IP when an EIP is unbound on current day

    4. Example

    Input

    
      https://eip.api.qcloud.com/v2/index.php?
      &<Public request parameters>
    
    

    Output

    
    {
        "code": 0,
        "message": "",
        "data": {
            "eipNumQuota": 20,
            "currentEipNum": 2,
            "dailyApplyQuota": 10,
            "dailyApplyCount": 7,
            "dailyAllocWanIpQuota": 10,
            "dailyAllocWanIpCount": 2    
        }
    }
    

    Was this page helpful?

    Was this page helpful?

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