StartGameServerSessionPlacement

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

1. API Description

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

This API is used to start placing 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: StartGameServerSessionPlacement.
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.
PlacementId Yes String Unique ID of starting game server session placement
GameServerSessionQueueName Yes String Game server session queue name
MaximumPlayerSessionCount Yes Integer Maximum number of concurrent players allowed by the game server to connect to the game session
DesiredPlayerSessions.N No Array of DesiredPlayerSession Player game session information
GameProperties.N No Array of GameProperty Player game session attributes
GameServerSessionData No String Game server session data
GameServerSessionName No String Game server session name
PlayerLatencies.N No Array of PlayerLatency Player latency

3. Output Parameters

Parameter Name Type Description
GameServerSessionPlacement GameServerSessionPlacement Game server session placement
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Starting placing game server session

Input Example

https://gse.tencentcloudapi.com/?Action=StartGameServerSessionPlacement
&PlacementId=PlacementId-3a7d34cd-5240-11ea-b02a-3464a91513fe
&GameServerSessionQueueName=PlacementTwo
&MaximumPlayerSessionCount=100
&<Common request parameters>

Output Example

{
  "Response": {
    "GameServerSessionPlacement": {
      "DnsName": "",
      "EndTime": null,
      "GameProperties": [],
      "GameServerSessionData": "",
      "GameServerSessionId": "",
      "GameServerSessionName": "",
      "GameServerSessionQueueName": "PlacementTwo",
      "GameServerSessionRegion": "",
      "IpAddress": "",
      "MatchmakerData": "",
      "MaximumPlayerSessionCount": 100,
      "PlacedPlayerSessions": [],
      "PlacementId": "PlacementId-3a7d34cd-5240-11ea-b02a-3464a91513fe",
      "PlayerLatencies": [],
      "Port": 0,
      "StartTime": "2020-02-18T11:17:23Z",
      "Status": "PENDING"
    },
    "RequestId": "84708eb1-0247-43f8-834e-c7edfdsfdgd53"
  }
}

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.

Was this page helpful?

Was this page helpful?

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