Last updated: 2021-05-11 10:58:55

1. API Description

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

This API is used to update a game server session.

A maximum of 1000 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. It should contain 1 to 256 ASCII characters.
MaximumPlayerSessionCount No Integer The maximum number of players, which cannot be less than 0.
Name No String Name of the game server session. It should contain 1 to 1024 ASCII characters.
PlayerSessionCreationPolicy No String Player session creation policy, which includes ACCEPT_ALL (allow all players) and DENY_ALL (reject all players).
ProtectionPolicy No String Protection policy, which includes NoProtection·(no protection), TimeLimitProtection (time-limited protection) and FullProtection (full protection)

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 properties

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

Input Example

&<Common request parameters>

Output Example

  "Response": {
    "GameServerSession": {
      "AvailabilityStatus": "Enable",
      "CreationTime": "2020-07-30T03:55:43Z",
      "CreatorId": "",
      "CurrentCustomCount": 0,
      "CurrentPlayerSessionCount": 0,
      "DnsName": "",
      "FleetId": "fleet-qp33caaa-35555",
      "GameProperties": [],
      "GameServerSessionData": "",
      "GameServerSessionId": "qcs::gse:ap-shanghai:uin/100000010000:gameserversession/fleet-qp33caaa-35555/gssess-qtk2222-uuu",
      "InstanceType": "S5.LARGE8",
      "IpAddress": "",
      "MatchmakerData": "",
      "MaxCustomCount": 0,
      "MaximumPlayerSessionCount": 100,
      "Name": "",
      "PlayerSessionCreationPolicy": "ACCEPT_ALL",
      "Port": 6000,
      "Status": "ACTIVATING",
      "StatusReason": "",
      "TerminationTime": null,
      "Weight": 5
    "RequestId": "s15960816666663333"

5. Developer Resources


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.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.ServiceNotOpened The service is not activated.