Domain name for API request: gse.tencentcloudapi.com.
This API is used to get the list of player sessions.
A maximum of 1000 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 parameter. The value used for this API: DescribePlayerSessions. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-11-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| GameServerSessionId | No | String | Game server session ID. It should contain 1 to 48 ASCII characters. |
| Limit | No | Integer | Maximum number of entries in a single query |
| NextToken | No | String | Pagination offset, which is used for querying the next page. It should contain 1 to 1024 ASCII characters. |
| PlayerId | No | String | Player ID. It should contain 1 to 1024 ASCII characters. |
| PlayerSessionId | No | String | Player session ID. It should contain 1 to 1024 ASCII characters. |
| PlayerSessionStatusFilter | No | String | Player session status. Valid values: RESERVED, ACTIVE, COMPLETED, TIMEDOUT |
| Parameter Name | Type | Description |
|---|---|---|
| PlayerSessions | Array of PlayerSession | Player session list Note: this field may return null, indicating that no valid values can be obtained. |
| NextToken | String | Pagination offset, which is used for querying the next page. It should contain 1 to 1024 ASCII characters. Note: this field may return null, indicating that no valid value is obtained. |
| 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 player sessions.
https://gse.tencentcloudapi.com/?Action=DescribePlayerSessions
&GameServerSessionId=qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-abcde
&Limit=5
&NextToken=nextToken-abc78-1122bc
&<common request parameters>
{
"Response": {
"NextToken": "nextToken-4hpp445-niuu789",
"PlayerSessions": [
{
"CreationTime": "2019-12-06T11:33:19Z",
"DnsName": "",
"FleetId": "fleet-00test-a5testzz",
"GameServerSessionId": "qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-abcde",
"IpAddress": "0000.0.0.0",
"PlayerData": "TestPlayerData",
"PlayerId": "",
"PlayerSessionId": "psess-d44990-test5",
"Port": 8000,
"Status": "COMPLETED",
"TerminationTime": "2019-12-06T11:33:18Z"
}
],
"RequestId": "0fffff4-oooo-43333d-9222-testaaa"
}
}
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 | Incorrect parameter value. |
| MissingParameter | Missing parameter. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | The operation is unauthorized. |
| UnauthorizedOperation.ServiceNotOpened | The service is not activated. |
Was this page helpful?