tencent cloud

All product documents
APIs
DocumentationAPIsVirtual Private CloudVPC APIsDescribeTrafficPackages
DescribeTrafficPackages
Last updated: 2024-11-25 20:07:15
DescribeTrafficPackages
Last updated: 2024-11-25 20:07:15

1. API Description

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

This API is used to query the details of shared traffic packages.

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: DescribeTrafficPackages.
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.
TrafficPackageIds.N No Array of String Traffic package IDs. Multiple values can be used.
Filters.N No Array of Filter Each request can have up to 10 Filters. TrafficPackageIds and Filters cannot be specified at the same time. The specific filter conditions are as follows:
  • traffic-package_id - String - Optional - Filter by the traffic package ID.
  • traffic-package-name - String - Optional - Filter by the traffic package name. Fuzzy match is not supported.
  • status - String - Optional - Filter by the traffic package status. Values: [AVAILABLE|EXPIRED|EXHAUSTED].
    		•
    Offset No Integer Pagination parameter
    Limit No Integer Pagination parameter

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible traffic packages
    TrafficPackageSet Array of TrafficPackage Traffic package information
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying details of all shared traffic packages under the current account

    This example shows you how to query details of all shared traffic packages under the current account.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "TrafficPackageSet": [
            {
                "TrafficPackageId": "tfp-g67jlh1j",
                "TrafficPackageName": "Unnamed",
                "TotalAmount": 10,
                "RemainingAmount": 10,
                "Status": "AVAILABLE",
                "CreatedTime": "2022-08-31T11:42:37Z",
                "Deadline": "2022-09-30T11:42:36Z",
                "DeductType": "FULL_TIME",
                "UsedAmount": 0,
                "TagSet": [
                    {
                        "Key": "aa",
                        "Value": "bb"
                    }
                ]
            }
        ],
        "RequestId": "e92ac36b-db69-4329-b030-9276b88d93c4"
    }
}

    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.TrafficPackageIdMalformed The traffic package ID is invalid.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon