CreateMatch

Last updated: 2021-04-06 14:12:06

1. API Description

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

This API is used to create a match.

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: CreateMatch.
Version Yes String Common parameter. The value used for this API: 2020-08-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
MatchName Yes String Match name. It can contain up to 128 bytes, supporting [a-zA-Z0-9-.]*.
RuleCode Yes String RuleCode
Timeout Yes Integer Timeout period in seconds. Value range: 1 600
ServerType Yes Integer Whether to request server resources for the matchmaking results. 0: no, 1: request GSE resources
MatchDesc No String Matchmaking description. Up to 1024 bytes are allowed.
NotifyUrl No String Only HTTP and HTTPS protocols are supported.
ServerRegion No String Region of the game server queue
ServerQueue No String Game server queue
CustomPushData No String Custom push data
ServerSessionData No String Game server session data
GameProperties.N No Array of StringKV Game attribute. It is an array of key-value structure.
LogSwitch No Integer Enable or disable the log. 0: disable, 1: enable
Tags.N No Array of StringKV Tag. It is an array of key-value structure.

3. Output Parameters

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

4. Example

Example1 Creating a match

Input Example

https://gpm.tencentcloudapi.com/?Action=CreateMatch
&MatchName=test
&MatchDesc=test
&RuleCode=rule-r4x6tk49
&Timeout=60
&NotifyUrl=https://test.com
&ServerType=1
&ServerRegion=ap-shanghai
&ServerQueue=gpmtest
&CustomPushData=test
&ServerSessionData=test
&LogSwitch=1
&GameProperties.0.Key=test
&GameProperties.0.Value=test
&Tags.0.Key=String
&Tags.0.Value=String
&<Common request parameters>

Output Example

{
  "Response": {
    "MatchInfo": {
      "AppId": "1300704415",
      "CreateTime": "2020-09-29 15:24:19",
      "CreateUin": "100012125188",
      "CustomPushData": "test",
      "GameProperties": [
        {
          "Key": "test",
          "Value": "test"
        }
      ],
      "LogSwitch": 1,
      "LogTopicId": "",
      "LogTopicName": "",
      "LogsetId": "",
      "LogsetName": "",
      "MatchCode": "match-58mnuqlz",
      "MatchDesc": "test",
      "MatchName": "test",
      "NotifyUrl": "https://test.com",
      "Region": "ap-shanghai",
      "RuleCode": "rule-r4x6tk49",
      "RuleName": "",
      "ServerQueue": "gpmtest",
      "ServerRegion": "ap-shanghai",
      "ServerSessionData": "test",
      "ServerType": 1,
      "Tags": [
        {
          "Key": "String",
          "Value": "String"
        }
      ],
      "Timeout": 60,
      "Uin": "100012125188"
    },
    "RequestId": "20e5c29d-fa33-45bd-8e90-5b00773fa4cb"
  }
}

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
AuthFailure CAM signature/authentication error
DryRunOperation The DryRun operation means that the request will be successful, but an extra DryRun parameter is passed.
FailedOperation Operation failed
FailedOperation.LimitMatchCount The number of the created matches exceeds the limit.
FailedOperation.ServiceUnavailable System error. If you cannot solve the problem, please submit a ticket.
FailedOperation.TagsOpeartionFailed The tagging operation failed
InternalError Internal error
InvalidAction The API does not exist.
InvalidParameter Parameter error
InvalidParameterValue Invalid parameter value
InvalidParameterValue.RuleNotFound The rule does not exist.
InvalidParameterValue.TagsLimitPermission No permission for this tag
InvalidParameterValue.ValueRangeLimit The value exceeds the range.
LimitExceeded Quota limit exceeded.
MissingParameter The parameter is missing.
NoSuchVersion API version does not exist.
OperationDenied Operation denied
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse Occupied resource
ResourceInsufficient Insufficient resources
ResourceNotFound Resource not found
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.CAMUnauthorizedOperation It is required to grant the GPM role permissions.
UnauthorizedOperation.UnauthorizedAction API permission authorization is needed.
UnauthorizedOperation.UserUnAuth The current account has not verified its identity. Please complete identity verification before using the service.
UnknownParameter Unknown parameter error
UnsupportedOperation Unsupported operation
UnsupportedRegion The API does not suppor