DescribeSessionStatistics

最后更新时间：2025-11-13 21:02:25

DescribeSessionStatistics

最后更新时间： 2025-11-13 21:02:25

1. API Description

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

Get session statistical values

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: DescribeSessionStatistics.
Version	Yes	String	Common Params. The value used for this API: 2022-03-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ProjectId	Yes	String	Project id.
DeviceId	No	String	Device id.
StartTime	No	Integer	Start time, unit: seconds.
EndTime	No	Integer	End time in seconds.

3. Output Parameters

Parameter Name	Type	Description
SessionNum	Integer	Number of sessions.
TotalDuration	Integer	Call duration, unit: minutes.
ActiveFieldDeviceNum	Integer	Number of active on-site devices.
ActiveRemoteDeviceNum	Integer	Number of active remote devices.
NotBadSessionRatio	Integer	Proportion of excellent sessions, unit: %.
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 Example 1

Input Example

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

{
    "ProjectId": "abcdefg",
    "EndTime": "1670000000",
    "DeviceId": "dev2",
    "StartTime": "0"
}

Output Example

{
    "Response": {
        "ActiveFieldDeviceNum": 1,
        "ActiveRemoteDeviceNum": 1,
        "NotBadSessionRatio": 100,
        "RequestId": "abcdefg-1d31-47bc-8725-76124984f005",
        "SessionNum": 6,
        "TotalDuration": 604
    }
}

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.
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameterValue	Parameter value error.
MissingParameter	Missing required parameters.
OperationDenied	Operation denied.
ResourceNotFound	The resource does not exist.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud