DescribeDeviceSessionList

Download PDF

Last updated: 2025-02-17 15:36:29

DescribeDeviceSessionList

Last updated: 2025-02-17 15:36:29

Download PDF

1. API Description

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

Getting the device session list

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: DescribeDeviceSessionList.
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.
PageNumber	Yes	Integer	Page number, beginning from 1.
PageSize	Yes	Integer	Number of entries per page.
DeviceId	No	String	Device id.
StartTime	No	Integer	Start time.
EndTime	No	Integer	End time.

3. Output Parameters

Parameter Name	Type	Description
Total	Integer	Total number.
DeviceSessionList	Array of SessionInfo	Conversation list.
Num	Integer	Number of items on this page.
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: DescribeDeviceSessionList
<Common request parameters>

{
    "PageNumber": "1",
    "PageSize": "10",
    "ProjectId": "abcdefg",
    "DeviceId": "dev2",
    "StartTime": "0",
    "EndTime": "1670000000"
}

Output Example

{
    "Response": {
        "DeviceSessionList": [
            {
                "EndTime": 1650000060,
                "FieldDeviceId": "dev2",
                "Quality": "good",
                "RemoteDeviceId": "dev2",
                "Resolution": "1920*1080",
                "SessionId": "abcdefg-50f7-4c60-9c89-e7076c8529a9-0",
                "StartTime": 1650000000
            }
        ],
        "RequestId": "abcdefg-186d-4dc5-9a36-6849446dd921",
        "Total": 1,
        "Num": 1
    }
}

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

Sign Up

Log in