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

1. API Description

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

This API is used to update a game server session.

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: UpdateGameServerSession.
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 Yes String Game server session ID
MaximumPlayerSessionCount No Integer Maximum number of players
Name No String Game server session name
PlayerSessionCreationPolicy No String Player session creation policy. Valid values: ACCEPT_ALL, DENY_ALL
ProtectionPolicy No String Protection policy. Valid values: NoProtection, TimeLimitProtection, FullProtection

3. Output Parameters

Parameter Name Type Description
GameServerSession GameServerSession Updated game session
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Updating game session attributes

This example shows you how to update the attributes of a game session.

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "GameServerSession": {
      "CreationTime": "2019-12-06T10:03:50Z",
      "CreatorId": "c1",
      "CurrentPlayerSessionCount": 1,
      "DnsName": "",
      "FleetId": "fleet-00test-a5testzz",
      "GameProperties": [],
      "GameServerSessionData": "testdata",
      "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",
      "MatchmakerData": "",
      "MaximumPlayerSessionCount": 10,
      "Name": "",
      "PlayerSessionCreationPolicy": "ACCEPT_ALL",
      "Port": 8000,
      "Status": "ACTIVE",
      "StatusReason": "",
      "TerminationTime": "2019-12-06T11:33:10Z"
    "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.


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.
InvalidParameterValue Incorrect parameter value.
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