JoinGameServerSessionBatch

Last updated: 2020-12-24 11:02:24

1. API Description

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

This API is used to join game server sessions in batch.

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: JoinGameServerSessionBatch.
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.
PlayerIds.N Yes Array of String Player ID list. At least 1 ID and up to 25 IDs.
PlayerDataMap No PlayerDataMap Player custom data

3. Output Parameters

Parameter Name Type Description
PlayerSessions Array of PlayerSession Player session list. Up to 25 sessions.
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.

4. Example

Example1 Creating a player session

This example shows you how to create a player session.

Input Example

POST / HTTP/1.1
Host: gse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: JoinGameServerSessionBatch
&<Common request parameters>

{
    "PlayerIds": [
        "xx"
    ], 
    "GameServerSessionId": "qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-abcde", 
    "PlayerDataMap": {
        "Value": "xx", 
        "Key": "xx"
    }
}

Output Example

{
  "Response": {
    "PlayerSessions": [
      {
        "CreationTime": "2019-12-06T11:33:19Z",
        "DnsName": "",
        "FleetId": "fleet-ptest40-f001",
        "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"
  }
}

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

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.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.ServiceNotOpened The service is not activated.
UnsupportedOperation Unsupported operation.

Was this page helpful?

Was this page helpful?

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