tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateBandwidthPackage

Last updated: 2023-08-23 14:11:39

1. API Description

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

This API is used to create a device bandwidth package or an IP bandwidth package.

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: CreateBandwidthPackage.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
NetworkType No String The network type of the bandwidth package. Default value: BGP. Valid values:
BGP
HIGH_QUALITY_BGP
ChargeType No String The billing mode of the bandwidth package. Default value: TOP5_POSTPAID_BY_MONTH. Valid values:
  • TOP5_POSTPAID_BY_MONTH: monthly top 5
  • PERCENT95_POSTPAID_BY_MONTH: monthly 95th percentile
  • FIXED_PREPAID_BY_MONTH: monthly subscription
    		•
    BandwidthPackageName No String The name of the bandwidth package.
    BandwidthPackageCount No Integer The number of bandwidth packages to create. Valid range: 1-20. It can only be “1” for bill-by-CVM accounts.
    InternetMaxBandwidth No Integer The limit of the bandwidth package in Mbps. The value '-1' indicates there is no limit. This feature is currently in beta.
    Tags.N No Array of Tag The list of tags to be bound.
    Protocol No String The protocol type of the bandwidth package. Valid values: 'ipv4' and 'ipv6'. Default value: 'ipv4'.

    3. Output Parameters

    Parameter Name Type Description
    BandwidthPackageId String The unique ID of the bandwidth package.
    BandwidthPackageIds Array of String The unique ID list of the bandwidth package (effective only when you apply for more than 1 bandwidth packages).
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a bandwidth package

    Input Example

    https://vpc.tencentcloudapi.com/?Action=CreateBandwidthPackage
&ChargeType=TOP5_POSTPAID_BY_MONTH
&NetworkType=BGP
&<Common request parameters>

    Output Example

    {
    "Response": {
        "BandwidthPackageId": "bwp-8rol****",
        "BandwidthPackageIds": [
            "bwp-8rol****"
        ],
        "RequestId": "57741638-47c2-4c6d-ac84-b88eb83dad06"
    }
}

    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.BalanceInsufficient Insufficient account balance.
    InternalServerError Internal error.
    InvalidAccount.NotSupported This account is not supported.
    InvalidParameterValue.Combination Invalid input parameters
    InvalidParameterValue.Empty Missing parameters.
    InvalidParameterValue.InstanceIdMalformed Incorrect instance ID.
    InvalidParameterValue.Range The parameter value is not in the specified range.
    InvalidParameterValue.TagNotExisted The tag and value do not exist.
    LimitExceeded.BandwidthPackageQuota Exceeded the upper limit of the bandwidth package quota.
    UnsupportedOperation Unsupported operation.
    UnsupportedOperation.AccountNotSupported This account is not supported.
    UnsupportedOperation.InstanceStateNotSupported This operation is not supported by the status of the instance bound with the IP address.
    UnsupportedOperation.InvalidResourceInternetChargeType This operation is not allowed under this billing mode.
    UnsupportedOperation.NotSupportedPurchaseCenterEgressResource
    UnsupportedOperation.UnsupportedRegion The service is not available in this country/region.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy