tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyAddressesBandwidth

Last updated: 2024-11-25 20:09:26

    1. API Description

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

    This API is used to adjust the bandwidth of Elastic IP, including EIP billed on a pay-as-you-go, monthly subscription, and bandwidth package basis.

    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: ModifyAddressesBandwidth.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    AddressIds.N Yes Array of String List of EIP IDs, such as “eip-xxxx”.
    InternetMaxBandwidthOut Yes Integer Target bandwidth value adjustment
    StartTime No Timestamp (Disused) The start time of the monthly bandwidth subscription
    EndTime No Timestamp (Disused) The end time of the monthly bandwidth subscription

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The async task ID. You can use the DescribeTaskResult API to query the task status.
    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 Adjusting the pay-as-you-go bandwidth

    This example shows you how to adjust the pay-as-you-go bandwidth.

    Input Example

    POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAddressesBandwidth
<Common request parameters>

{
    "InternetMaxBandwidthOut": "2",
    "AddressIds": [
        "eip-alfxy9c8"
    ]
}

    Output Example

    {
    "Response": {
        "TaskId": "11531422",
        "RequestId": "24cfceab-3492-482c-b86f-27f598b1b044"
    }
}

    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.TaskFailed Task execution failed.
    InternalServerError Internal error.
    InvalidAddressId.NotFound The specified EIP does not exist.
    InvalidParameterValue.AddressIdMalformed This IP address ID is invalid.
    InvalidParameterValue.AddressNotFound Unable to find the address.
    InvalidParameterValue.AddressTypeConflict Invalid IP address type
    InvalidParameterValue.BandwidthOutOfRange The bandwidth exceeds the limit.
    InvalidParameterValue.BandwidthTooSmall The selected bandwidth is smaller than the minimum permissible range.
    InvalidParameterValue.InconsistentInstanceInternetChargeType The billing mode of this instance is different from that of others.
    InvalidParameterValue.InstanceIdMalformed Incorrect instance ID.
    InvalidParameterValue.InstanceNoCalcIP Request failed: this instance does not have a CalcIP (device IP).
    InvalidParameterValue.InstanceNoWanIP Request failed: this instance does not have a WanIP (public IP).
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.ResourceExpired The resource has expired.
    InvalidParameterValue.ResourceNotExisted The resource is not associated with this bandwidth package.
    InvalidParameterValue.ResourceNotSupport The resource does not support this operation.
    OperationDenied.AddressInArrears The specified public IP is isolated.
    OperationDenied.MutexTaskRunning Mutually exclusive tasks are executing.
    UnsupportedOperation.ActionNotFound The port does not exist.
    UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
    UnsupportedOperation.InstanceStateNotSupported This operation is not supported by the status of the instance bound with the IP address.
    UnsupportedOperation.UnpaidOrderAlreadyExists Overdue payments are found under this account. Please complete the payment first.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy