Domain name for API request: live.intl.tencentcloudapi.com.
Live Streaming Push Bandwidth and Traffic Data Query. The push billing will first compare the global push usage with the global playback usage. If the billing conditions are met, billing will be issued based on the usage in each region. For details, refer to the Billing Documentation.(https://www.tencentcloud.com/document/product/267/34175?from_cn_redirect=1)
A maximum of 100 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: DescribePushBandwidthAndFluxList. |
| Version | Yes | String | Common Params. The value used for this API: 2018-08-01. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| StartTime | Yes | String | Query start time point, accurate to minute granularity. The interface query supports two time formats: YYYY-MM-DDThh:mm:ssZ: UTC time format, refer to ISO date format descriptionfor details. YYYY-MM-DD hh:mm:ss: When using this format, it represents Beijing time by default. Queries for the most recent two months are supported. The span between query start and end time cannot exceed 31 days. |
| EndTime | Yes | String | Query end time point, accurate to minute granularity. The interface query supports two time formats: YYYY-MM-DDThh:mm:ssZ: UTC time format, refer to ISO date format descriptionfor details. YYYY-MM-DD hh:mm:ss: When using this format, it represents Beijing time by default. Queries for the most recent two months are supported. The span between query start and end time cannot exceed 31 days. |
| PushDomains.N | No | Array of String | Domain name, you can fill in multiple. If left blank, it represents the overall data. |
| MainlandOrOversea | No | String | Optional values: Mainland: Query data for Mainland China (domestic). Oversea: Query data for international/regions such as Hong Kong, Macao, Taiwan (overseas). If left blank, it defaults to querying global data (domestic + overseas). |
| Granularity | No | Integer | Data granularity, supports the following granularities: 5: 5-minute granularity (span cannot exceed 1 day), 60: 1-hour granularity (span cannot exceed 1 month), 1440: daily granularity (span cannot exceed 1 month). Default value: 5. |
| RegionNames.N | No | Array of String | Region, mapping table as follows: China Mainland: Mainland China, Asia Pacific I: Asia Pacific Region 1, Asia Pacific II: Asia Pacific Region 2, Asia Pacific III: Asia Pacific Region 3, Europe: Europe, North America: North America, South America: South America, Middle East: Middle East, Africa: Africa. |
| CountryNames.N | No | Array of String | Country, the mapping table is referenced as follows in the document: https://www.tencentcloud.com/document/product/267/34019?from_cn_redirect=1. |
| Parameter Name | Type | Description |
|---|---|---|
| PeakBandwidthTime | String | Peak bandwidth timestamp, using UTC time format, e.g., 2019-01-08T10:00:00Z. Note: Beijing time value equals UTC time value + 8 hours, expressed in ISO 8601 standard format. For details, refer to ISO Date Format Description.(https://www.tencentcloud.com/document/product/266/11732?from_cn_redirect=1#I) |
| PeakBandwidth | Float | Peak bandwidth, measured in Mbps. |
| P95PeakBandwidthTime | String | 95th percentile peak bandwidth timestamp, using UTC time format, e.g., 2019-01-08T10:00:00Z. Note: Beijing time value equals UTC time value + 8 hours, expressed in ISO 8601 standard format. For details, refer to ISO Date Format Description.(https://www.tencentcloud.com/document/product/266/11732?from_cn_redirect=1#I). |
| P95PeakBandwidth | Float | 95th percentile peak bandwidth, measured in Mbps. |
| SumFlux | Float | Total traffic, measured in MB. |
| DataInfoList | Array of BillDataInfo | Detailed data 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. |
POST / HTTP/1.1
Host: live.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePushBandwidthAndFluxList
<public params>
{
"StartTime": "2019-02-01T00:00:00+08:00",
"EndTime": "2019-02-03T00:00:00+08:00",
"PushDomains": [
"tx-game.push.yximgs.com",
"tx-game2.push.yximgs.com"
],
"MainlandOrOversea": "Mainland",
"Granularity": 5
}
{
"Response": {
"P95PeakBandwidth": 117042.495,
"P95PeakBandwidthTime": "2019-02-01T00:00:00+08:00",
"DataInfoList": [
{
"Bandwidth": 117042.495,
"Flux": 4389093.551,
"Time": "2019-02-01T00:00:00+08:00",
"PeakTime": "2019-02-01T00:00:00+08:00"
},
{
"Bandwidth": 110364.995,
"Flux": 4138687.32,
"Time": "2019-02-01T00:05:00+08:00",
"PeakTime": "2019-02-01T00:05:00+08:00"
},
{
"Bandwidth": 99380.978,
"Flux": 3726786.679,
"Time": "2019-02-01T00:10:00+08:00",
"PeakTime": "2019-02-01T00:10:00+08:00"
}
],
"PeakBandwidth": 117042.495,
"PeakBandwidthTime": "2019-02-01T00:00:00+08:00",
"RequestId": "f54e3deb-f318-4148-8a68-3c959642f9ec",
"SumFlux": 12254567.55
}
}
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 |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameterValue | Invalid parameter value. |
| MissingParameter | Parameter missing. |
| ResourceNotFound.ForbidService | You are blocked. |
| ResourceNotFound.FreezeService | Service suspended. |
| ResourceNotFound.StopService | The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first. |
| ResourceNotFound.UserDisableService | You disabled the service. |
フィードバック