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.
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 |
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. |
This example shows you how to query the list of shared traffic packages under the current account.
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTrafficPackages
<Common request parameters>
{}
{
"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"
}
}
This example shows you how to query details of all shared traffic packages under the current account.
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTrafficPackages
<Common request parameters>
{}
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?