tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTrafficPackages

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

1. API Description

Domain name for API request: vpc.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 No String Common Params. This parameter is not required for this API.
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, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of shared traffic packages under the current account

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

    Input Example

    POST / HTTP/1.1
Host: vpc.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"
    }
}

    Example2 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.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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy