Domain name for API request: gse.tencentcloudapi.com.
This API is used to join a game server session.
A maximum of 1000 requests can be initiated per second for this API.
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: JoinGameServerSession. |
| 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. |
| PlayerId | Yes | String | Player ID. Up to 1024 ASCII characters are allowed. |
| PlayerData | No | String | Player custom data. Up to 2048 ASCII characters are allowed. |
| Parameter Name | Type | Description |
|---|---|---|
| PlayerSession | PlayerSession | Player 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. |
This example shows you how to create one single player session.
https://gse.tencentcloudapi.com/?Action=JoinGameServerSession
&GameServerSessionId=qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-p70zzzz/gssess-aaaa-ilqsssu/PlacementId-124ddda-4e28-1111-222b-abcde
&PlayerData=testData
&PlayerId=testPlayer
&<common request parameters>
{
"Response": {
"PlayerSession": {
"CreationTime": "2019-12-05T15:15:33Z",
"DnsName": "",
"FleetId": "fleet-sss-test01",
"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": "imangozhang",
"PlayerId": "100",
"PlayerSessionId": "psess-d44990-test5",
"Port": "8000",
"Status": "RESERVED",
"TerminationTime": null
},
"RequestId": "0fffff4-oooo-43333d-9222-testaaa"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| 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. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?