tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBandwidthPackages

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

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.

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: DescribeBandwidthPackages.
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.
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. Valid values: HIGH_QUALITY_BGP, BGP, SINGLEISP, and ANYCAST.
  • charge-type - String - Required: No - (Filter condition) Filter by the bandwidth package billing mode. Valid values: TOP5_POSTPAID_BY_MONTH and PERCENT95_POSTPAID_BY_MONTH.
  • resource.resource-type - String - Required: No - (Filter condition) Filter by the bandwidth package resource type. Valid values: 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.
  • tag-key - String - Required: No - (Filter condition) Filter by tag key.
  • tag-value - String - Required: No - (Filter condition) Filter by tag value.
  • tag:tag-key - String - Required: No - (Filter condition) Filter by tag key-value pair. Use a specific tag key to replace tag-key.
    		•
    Offset No Integer Offset. This value defaults to 0. For more information, see the relevant sections in API Overview.
    Limit No Integer Number of bandwidth packages returned. This value defaults to 20. The maximum is 100. For more information, see the relevant sections in API Overview.

    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

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

{
    "Filters": [
        {
            "Values": [
                "BGP"
            ],
            "Name": "network-type"
        }
    ]
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "BandwidthPackageSet": [
            {
                "BandwidthPackageId": "bwp-p6am50q0",
                "BandwidthPackageName": "gongxiang1",
                "Status": "CREATED",
                "NetworkType": "BGP",
                "ChargeType": "FIXED_PREPAID_BY_MONTH",
                "CreatedTime": "2019-12-31T16:48:49Z",
                "ResourceSet": [
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-hbhcbwci",
                        "AddressIp": "134.175.210.185"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-bksqvcue",
                        "AddressIp": "193.112.158.4"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-rlwrl9zg",
                        "AddressIp": "193.112.128.149"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-0a0z6e86",
                        "AddressIp": "193.112.214.231"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-loq78a2u",
                        "AddressIp": "193.112.214.146"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-9b23ko6g",
                        "AddressIp": "193.112.195.106"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-l3utrirm",
                        "AddressIp": "193.112.214.252"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-biawxrrg",
                        "AddressIp": "193.112.161.62"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-gm8dcbmw",
                        "AddressIp": "129.204.145.2"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-f3yjemhw",
                        "AddressIp": "134.175.169.60"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-oahxub36",
                        "AddressIp": "106.53.87.77"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-ej9oasck",
                        "AddressIp": "193.112.186.94"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-iivgnxr6",
                        "AddressIp": "106.52.155.79"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-9pva2ne6",
                        "AddressIp": "106.52.167.45"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-fqexkiku",
                        "AddressIp": "129.204.251.201"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-dorh1ejy",
                        "AddressIp": "106.55.92.150"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-pdxzxuzs",
                        "AddressIp": "42.194.204.43"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-26tl14zo",
                        "AddressIp": "106.52.248.58"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-1n624fs0",
                        "AddressIp": "106.55.63.197"
                    },
                    {
                        "ResourceType": "Address",
                        "ResourceId": "eip-j4s0mcug",
                        "AddressIp": "106.55.92.154"
                    }
                ],
                "Bandwidth": 500
            }
        ],
        "RequestId": "e0ee5afd-a684-4a4c-9fff-ef5d626aed46"
    }
}

    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
    InvalidParameter.InvalidFilter The filter rule is invalid.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.BandwidthPackageIdMalformed Incorrect bandwidth package ID.
    InvalidParameterValue.InvalidBandwidthPackageChargeType Invalid billing mode of bandwidth package
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy