DescribeGameServerSessions

Last updated: 2020-07-03 09:29:04

1. API Description

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

This API is used to query the list of game server sessions.

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 parameter. The value used for this API: DescribeGameServerSessions.
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.
AliasId No String Alias ID
FleetId No String Fleet ID
GameServerSessionId No String Game server session ID
Limit No Integer Maximum number of entries in a single query
NextToken No String Pagination offset, which is used for querying the next page
StatusFilter No String Game server session status. Valid values: ACTIVE, ACTIVATING, TERMINATED, TERMINATING, ERROR

3. Output Parameters

Parameter Name Type Description
GameServerSessions Array of GameServerSession Game server 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
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying game session list

This example shows you how to query the list of game sessions.

Input Example

https://gse.tencentcloudapi.com/?Action=DescribeGameServerSessions
&AliasId=a
&GameServerSessionId=qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-111222
&Limit=1
&NextToken=nextToken-4hpp445-niuu789
&StatusFilter=ACTIVATING
&<Common request parameters>

Output Example

{
  "Response": {
    "GameServerSessions": [
      {
        "CreationTime": "2019-12-05T12:04:28Z",
        "CreatorId": "c2",
        "CurrentPlayerSessionCount": "0",
        "DnsName": "",
        "FleetId": "fleet-00test-a5testzz",
        "GameProperties": [],
        "GameServerSessionData": "",
        "GameServerSessionId": "qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-111222",
        "IpAddress": "0000.0.0.0",
        "MatchmakerData": "",
        "MaximumPlayerSessionCount": "10",
        "Name": "",
        "PlayerSessionCreationPolicy": "ACCEPT_ALL",
        "Port": "8000",
        "Status": "ACTIVATING",
        "StatusReason": "",
        "TerminationTime": "2019-12-05T04:04:28Z"
      }
    ],
    "NextToken": "",
    "RequestId": "0fffff4-oooo-43333d-9222-testaaa"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

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.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help