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

1. API Description

Domain name for API request:

This API is used to query the matchmaking list and paginate the query result.

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: DescribeMatches.
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.
PageNumber No Integer The current page number. If this parameter is left empty, all queried matches will be obtained.
PageSize No Integer Number of matchmaking lists per page. If this parameter is left empty, all queried matches will be obtained.
SearchType No String Query type (optional). Valid values: match (query by matchCode or matchName), rule (query by ruleCode or ruleName), and other types (not filtered)
Keyword No String Keyword. Enter a keyword about SearchType to query.
Tags.N No Array of Tag Tags. Enter a tag for querying.

3. Output Parameters

Parameter Name Type Description
MatchInfoList Array of MatchInfo Matchmaking information list
Note: this field may return null, indicating that no valid value is obtained.
TotalCount Integer Total number of results
PageNumber Integer The current page number. The first page will be returned by default if this parameter is left empty.
PageSize Integer The number of matches per page. If this parameter is left empty, 30 matches are displayed per page by default. Maximum value: 30
SearchType String Query type (optional). Valid values: matchName (query by match name), matchCode (query by matchCode), ruleName (query by rule name), and tag (query by tag key/value)
Keyword String Keyword for querying (optional)
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the matchmaking list

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "Keyword": "match-58mnuqlz",
    "MatchInfoList": [
        "AppId": "1300704415",
        "CreateTime": "2020-09-29 15:24:20",
        "CreateUin": "100012125188",
        "CustomPushData": "test",
        "GameProperties": [
            "Key": "test",
            "Value": "test"
        "LogSwitch": 1,
        "LogTopicId": "",
        "LogTopicName": "",
        "LogsetId": "",
        "LogsetName": "",
        "MatchCode": "match-58mnuqlz",
        "MatchDesc": "test",
        "MatchName": "test",
        "NotifyUrl": "",
        "Region": "ap-shanghai",
        "RuleCode": "rule-r4x6tk49",
        "RuleName": "test",
        "ServerQueue": "gpmtest",
        "ServerRegion": "ap-shanghai",
        "ServerSessionData": "test",
        "ServerType": 1,
        "Tags": [
            "Key": "String",
            "Value": "String"
        "Timeout": 60,
        "Uin": "100012125188"
    "PageNumber": 1,
    "PageSize": 10,
    "RequestId": "6e0c3a5d-a8cc-4eaf-bdff-214789ac2326",
    "SearchType": "matchCode",
    "TotalCount": 1

5. Developer Resources


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.ServiceUnavailable System error. If you cannot solve the problem, please submit a ticket.
InternalError Internal error
InvalidAction The API does not exist.
InvalidParameter Parameter error
InvalidParameterValue Invalid parameter value
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.
ResourceUnavailable.CLSServiceNotActivated The CLS service has not been activated.
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.
UnknownParameter Unknown parameter error
UnsupportedOperation Unsupported operation
UnsupportedRegion The API does not support the region passed in.

Was this page helpful?