International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    DescribeBandwidthPackages

    Last updated: 2020-12-04 12:44:58
    Download PDF

    1. API Description

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

    This API is used to query bandwidth package information, including the unique ID of the bandwidth package, the type, the billing mode, the name, and the resource information.

    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: DescribeBandwidthPackages.
    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.
    BandwidthPackageIds.N No Array of String The unique ID list of bandwidth packages.
    Filters.N No Array of Filter Each request can have up to 10 Filters. BandwidthPackageIds and Filters cannot be specified at the same time. The specific filter conditions are as follows:
  • bandwidth-package_id - String - Required: No - (Filter condition) Filter by the unique ID of the bandwidth package.
  • bandwidth-package-name - String - Required: No - (Filter condition) Filter by the bandwidth package name. Fuzzy filtering is not supported.
  • network-type - String - Required: No - (Filter condition) Filter by the bandwidth package type. Types include 'BGP', 'SINGLEISP', and 'ANYCAST'.
  • charge-type - String - Required: No - (Filter condition) Filter by the bandwidth package billing mode. Billing modes include 'TOP5_POSTPAID_BY_MONTH' and 'PERCENT95_POSTPAID_BY_MONTH'.
  • resource.resource-type - String - Required: No - (Filter condition) Filter by the bandwidth package resource type. Resource types include 'Address' and 'LoadBalance'.
  • resource.resource-id - String - Required: No - (Filter condition) Filter by the bandwidth package resource ID, such as 'eip-xxxx' and 'lb-xxxx'.
  • resource.address-ip - String - Required: No - (Filter condition) Filter by the bandwidth package resource IP.
    		•
    Offset No Integer Offset of the query results
    Limit No Integer Max number of the bandwidth packages to be returned.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of eligible bandwidth packages.
    BandwidthPackageSet Array of BandwidthPackage Detail information of the bandwidth package.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying bandwidth package resources

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeBandwidthPackages
&Filters.0.Name=network-type
&Filters.0.Values.0=BGP
&<Common request parameters>

    Output Example

    {
  "Response": {
    "TotalCount": 1,
    "BandwidthPackageSet": [
      {
        "BandwidthPackageId": "bwp-drmwgz9k",
        "NetworkType": "BGP",
        "ChargeType": "TOP5_POSTPAID_BY_MONTH",
        "BandwidthPackageName": "test",
        "CreatedTime": "2018-07-07T09:12:00Z",
        "Status": "CREATED",
        "ResourceSet": [
          {
            "ResourceType": "Address",
            "ResourceId": "eip-53wbxk2o",
            "AddressIp": "203.195.149.219"
          }
        ]
      }
    ],
    "RequestId": "e886604e-6f02-4139-a596-8f959f8dfbe3"
  }
}

    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
    InvalidParameterValue Incorrect parameter value.

    Was this page helpful?

    Confirm

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Hide
    Submit a TicketContact Us
    Help
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyTerms of ServiceCookie Policy