DescribeMatchingProgress

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

1. API Description

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

This API is used to query the matching progress.

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: DescribeMatchingProgress.
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.
MatchTicketIds.N Yes Array of MTicket List of MatchTicket IDs. It can contain up to 12 IDs.

3. Output Parameters

Parameter Name Type Description
MatchTickets Array of MatchTicket MatchTicket list
Note: this field may return null, indicating that no valid value is obtained.
ErrCode Integer Error code
Note: this field may return null, indicating that no valid value is obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Obtaining the matching progress information

Input Example

https://gpm.tencentcloudapi.com/?Action=DescribeMatchingProgress
&MatchTicketIds.0.MatchCode=match-lipp
&MatchTicketIds.0.MatchTicketId=ml0urJm
&<Common request parameters>

Output Example

{
  "Response": {
    "ErrCode": 0,
    "MatchTickets": [
      {
        "EndTime": "",
        "Id": "ml0urJm",
        "MatchCode": "match-lipp",
        "MatchResult": "",
        "MatchType": "",
        "Players": [
          {
            "CustomPlayerStatus": 0,
            "CustomProfile": "",
            "Id": "fisher0",
            "MatchAttributes": [
              {
                "ListValue": [],
                "MapValue": [],
                "Name": "numberAttr",
                "NumberValue": 10,
                "StringValue": "",
                "Type": 0
              },
              {
                "ListValue": [],
                "MapValue": [],
                "Name": "stringAttr",
                "NumberValue": 0,
                "StringValue": "stringAttrVal",
                "Type": 1
              },
              {
                "ListValue": [
                  "listAttrVal1",
                  "listAttrVal2",
                  "listAttrVal3"
                ],
                "MapValue": [],
                "Name": "listAttr",
                "NumberValue": 0,
                "StringValue": "",
                "Type": 2
              },
              {
                "ListValue": [],
                "MapValue": [
                  {
                    "Key": "mapAttrVal1",
                    "Value": 10
                  },
                  {
                    "Key": "mapAttrVal2",
                    "Value": 20
                  },
                  {
                    "Key": "mapAttrVal3",
                    "Value": 30
                  }
                ],
                "Name": "mapAttr",
                "NumberValue": 0,
                "StringValue": "",
                "Type": 3
              }
            ],
            "Name": "playerName0",
            "RegionLatencies": [
              {
                "Latency": 100,
                "Region": "ap-guangzhou"
              },
              {
                "Latency": 100,
                "Region": "ap-beijing"
              }
            ],
            "Team": "playerTeam0"
          }
        ],
        "StartTime": "2020-09-05T11:11:15Z",
        "Status": "TIMEDOUT",
        "StatusMessage": "",
        "StatusReason": ""
      }
    ],
    "RequestId": "1a68664b-d796-407b-ab7b-2dbc2a12f8f5"
  }
}

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
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.MatchCodeNotFound MatchCode does not exist.
InvalidParameterValue.MatchTicketIdNotFound The MatchTicket ID does not exist.
InvalidParameterValue.MatchTicketLimit The length of MatchTicket list exceeds the limit.
MissingParameter The parameter is missing.
NoSuchVersion API version does not exist.
OperationDenied Operation denied
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation.UnauthorizedAction API permission authorization is needed.
UnknownParameter Unknown parameter error

Was this page helpful?