tencent cloud

Feedback

DescribeBandwidthPackageResources

Last updated: 2022-08-24 17:36:48

1. API Description

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

This API is used to query resources in a bandwidth package based on the unique package ID. You can filter the result by specifying conditions and paginate the query results.

A maximum of 10 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: DescribeBandwidthPackageResources.
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.
BandwidthPackageId Yes String Unique ID of the bandwidth package in the form of bwp-11112222.
Filters.N No Array of Filter Each request can have up to 10 Filters and 5 Filter.Values. AddressIds and Filters cannot be specified at the same time. The specific filter conditions are as follows:
  • resource-id - String - Required: no - (Filter condition) Filters by the unique ID of resources in a bandwidth package, such as eip-11112222.
  • resource-type - String - Required: no - (Filter condition) Filters by the type of resources in a bandwidth package. It now supports only EIP (Address) and load balancer (LoadBalance).
  • Offset No Integer The offset. Default value: 0. For more information on Offset, see the relevant sections in API Introduction.
    Limit No Integer The number of returned results. Default value: 20. Maximum value: 100. For more information on Limit, see the relevant sections in API Introduction.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of eligible resources in the bandwidth package.
    ResourceSet Array of Resource The list of resources in 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 resources in a bandwidth package

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeBandwidthPackageResources
    &BandwidthPackageId=bwp-7umnal1o
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "TotalCount": 2,
            "ResourceSet": [
                {
                    "ResourceType": "Address",
                    "ResourceId": "eip-60z7i46d",
                    "AddressIp": "139.199.XX.XX"
                },
                {
                    "ResourceType": "Address",
                    "ResourceId": "eip-d97psd1o",
                    "AddressIp": "139.198.XX.XX"
                }
            ],
            "RequestId": "ecaa7a90-a2fd-4fa3-8bf8-7d0723c95a99"
        }
    }
    

    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 A parameter error occurred.
    InvalidParameter.InvalidFilter The filter rule is invalid.
    InvalidParameterValue.BandwidthPackageIdMalformed Incorrect bandwidth package ID.
    InvalidParameterValue.BandwidthPackageNotFound Failed to query the bandwidth package
    InvalidParameterValue.ResourceIdMalformed The resource ID is incorrect.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support