DescribeClientUploadAccelerationUsageData

Download PDF

DescribeClientUploadAccelerationUsageData

Last updated: 2024-03-27 16:09:06

Download PDF

1. API Description

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

This interface returns client upload acceleration statistics within the query time range.

You can query the client upload acceleration statistics in the last 365 days.
The query time span does not exceed 90 days.
If the query time span exceeds 1 day, data with day granularity will be returned. Otherwise, data with 5-minute granularity will be returned.

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: DescribeClientUploadAccelerationUsageData.
Version	Yes	String	Common Params. The value used for this API: 2018-07-17.
Region	No	String	Common Params. This parameter is not required.
StartTime	Yes	String	The start date for the query in ISO date format.
EndTime	Yes	String	The end date for the query in ISO date format. The end date must be later than the start date.
SubAppId	No	Integer	The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
Type	No	String	The client upload acceleration type. Valid values: AccelerationWithHTTP: Acceleration of HTTP transmission AccelerationWithQUIC: Acceleration of QUIC transmission If you do not specify this parameter, the usage of both types will be queried.

3. Output Parameters

Parameter Name	Type	Description
ClientUploadAccelerationUsageDataSet	Array of StatDataItem	The usage of client upload acceleration.
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 the usage of client upload acceleration

Input Example

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

{
    "StartTime": "2020-09-07T00:00:00+08:00",
    "EndTime": "2020-09-09T23:59:59+08:00",
    "Type": "AccelerationWithQUIC"
}

Output Example

{
    "Response": {
        "ClientUploadAccelerationUsageDataSet": [
            {
                "Time": "2020-09-07T00:00:00+08:00",
                "Value": 2
            },
            {
                "Time": "2020-09-08T00:00:00+08:00",
                "Value": 2
            },
            {
                "Time": "2020-09-09T00:00:00+08:00",
                "Value": 2
            }
        ],
        "RequestId": "requestId"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation	Operation failed.
FailedOperation.InvalidVodUser	The VOD service is not activated.
InternalError	Internal error.
InvalidParameterValue	Incorrect parameter value.

tencent cloud

Recent Pages

DescribeClientUploadAccelerationUsageData

1. API Description

2. Input Parameters

3. Output Parameters

4. Example