EndGameServerSessionAndProcess

Last updated: 2021-06-23 17:07:03

1. API Description

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

This API is used to terminate the game server session and the corresponding process, which is applicable to time-limited protection and no protection.

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: EndGameServerSessionAndProcess.
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 No String Game server session ID. If a game server session ID is passed in, its corresponding processes, game server sessions, and player sessions will be terminated.
IpAddress No String The public IP of the CVM. You need to pass in IpAddress and Port at the same time to terminate the matched processes, game server sessions and player sessions (if any exists). It does not take effect in case only the IpAddress passed in.
Port No Integer Port number. Value range: 1025 - 60000. You need to pass in IpAddress and Port at the same time to terminate the matched processes, game server sessions (if any exists) and player sessions (if any exists). It does not take effect in case only the IpAddress passed in.

3. Output Parameters

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

4. Example

Example1 Terminating the process of the game server session

Input Example

https://gse.tencentcloudapi.com/?Action=EndGameServerSessionAndProcess
&GameServerSessionId=qcs::gse:ap-shanghai:uin/1112222:gameserversession/fleet-qp3ga-pxxx/xxx
&IpAddress=0.0.0.0
&Port=8888
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "84708eb1-0247-43f8-834e-c7edfdsfdgd53"
  }
}

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.
MissingParameter Missing parameter.