CreateGameServerSession

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

1. API Description

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

This API is used to create 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: CreateGameServerSession.
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.
MaximumPlayerSessionCount Yes Integer The maximum number of players, which cannot be less than 0.
AliasId No String Alias ID. You need to specify an alias ID or fleet ID for each request. If both of them are specified, the fleet ID shall prevail.
CreatorId No String Creator ID. Up to 1024 ASCII characters are allowed.
FleetId No String Fleet ID. You need to specify an alias ID or fleet ID for each request. If both of them are specified, the fleet ID shall prevail.
GameProperties.N No Array of GameProperty Game attributes. Up to 16 groups of attributes are allowed.
GameServerSessionData No String The attribute details of game server session. Up to 4096 ASCII characters are allowed.
GameServerSessionId No String The custom ID of game server session. Up to 4096 ASCII characters are allowed.
IdempotencyToken No String Idempotency token. Up to 48 ASCII characters are allowed.
Name No String The name of game server session. Up to 1024 ASCII characters are allowed.

3. Output Parameters

Parameter Name Type Description
GameServerSession GameServerSession Game server session
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 Creating game server session

This example shows you how to create a game server session.

Input Example

https://gse.tencentcloudapi.com/?Action=CreateGameServerSession
&AliasId=alias-aatest-66bb
&MaximumPlayerSessionCount=10
&<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": "127.0.0.1",
      "MatchmakerData": "",
      "MaxCustomCount": 0,
      "MaximumPlayerSessionCount": 100,
      "Name": "",
      "PlayerSessionCreationPolicy": "ACCEPT_ALL",
      "Port": 6000,
      "Status": "ACTIVATING",
      "StatusReason": "",
      "TerminationTime": null,
      "Weight": 5
    },
    "RequestId": "s15960816666663333"
  }
}

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.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
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.