CreateBandwidthPackage

Last updated: 2021-05-27 11:34:32

    1. API Description

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

    This API is used to create device bandwidth packages and IP bandwidth packages

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: CreateBandwidthPackage.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    NetworkType No String The type of the bandwidth package. Valid values: HIGH_QUALITY_BGP, BGP, SINGLEISP, and ANYCAST.
    ChargeType No String The bandwidth package billing mode. Valid values: 'TOP5_POSTPAID_BY_MONTH' and 'PERCENT95_POSTPAID_BY_MONTH'.
    BandwidthPackageName No String The name of the bandwidth package.
    BandwidthPackageCount No Integer The number of bandwidth packages (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-8rolc8ec",
      "BandwidthPackageIds": [
        "bwp-8rolc8ec"
      ],
      "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
    InternalServerError Internal error.
    InvalidAccount.NotSupported This account is not supported.