• 
• 开发者中心
• >
• 云游戏
• >
• OpenAPI文档
• >
• PCU信息管理



文档版本：20220113-100

变更历史：

1 PCU信息简介

Peak concurrent users简称PCU，表示峰值并发用户数。

2 签名算法

2.1 签名算法说明

海马云API会对每个请求进行身份验证，用户需要使用安全凭证，经过特定的步骤对请求进行签名（Signature），每个请求都需要在公共参数中指定该签名结果并以指定的方式和格式发送请求。签名通过以下方式帮助保护请求：

• 验证请求者的身份。
  签名确保请求是由持有有效访问密钥的人发送的。请联系项目对接人员获取密钥相关信息。
• 保护传输中的数据。
  为了防止请求在传输过程中被篡改，海马云API会使用请求参数来计算请求的base64编码，并将生成的base64编码加密后作为请求的一部分，发送到海马云API服务器。服务器会使用收到的请求参数以同样的过程计算base64编码，并验证请求中的base64编码。如果请求被篡改，将导致base64编码不一致，海马云API将拒绝本次请求。

2.2 签名生成步骤

1) 接入方使用此格式拼接：key:%s,rand:%s,timestamp:%d,expiryInterval:%d，tokenRaw。

2) 接入方将tokenRaw使用md5生成32位摘要信息，token。

3) 接入方将payload描述的内容经过encode编码，传入encoded字段。

4) 接入方按照此格式拼接数据：accessKeyId:%s,encoded:%s,token:%s，记作signRaw。

5) 接入方将signRaw使用md5生成32位摘要信息，记作sign。

6) 海马云在验签通过后，会将encode数据经过base64解码后还原到payload字段中。

⚠注意：

接入方不通过payload传数据，payload由海马云经过base64解码后还原。

表2-1 签名算法参数说明

2.3 签名示例

为了更清楚地解释签名过程，下面以实际python编程为例，将上述的签名过程具体实现。代码只为解释签名过程，并不具备通用性。

#!/usr/bin/python3
# -*- coding: utf-8 -*-
import base64
import hashlib
import json
import time
t = time.time()
timestamp = (int(round(t * 1000))) # 毫秒级时间  

def generate_sign(accessKeyId, apiToken, payload, expiry_interval=1000000):
    m = hashlib.md5()

    # 步骤1
    original_token_str = 'key:%s,rand:%s,timestamp:%d,expiryInterval:%d' % (apiToken, '1', timestamp, expiry_interval)      

    # 步骤2
    m.update(original_token_str.encode('utf-8'))
    str_md5 = m.hexdigest()       

    # 步骤3
    str_payload = json.dumps(payload, separators=(',', ":"))
    base64_payload = base64.encodebytes(str_payload.rstrip('\n').encode())
    decode = base64_payload.decode('utf-8')   

    # 步骤4 
    original_sign_str = 'accessKeyId:%s,encoded:%s,token:%s' % (accessKeyId, decode, str_md5)  

    # 步骤5
    n = hashlib.md5()
    n.update(original_sign_str.encode('utf-8'))
    return n.hexdigest()  

3 PCU状态信息查询接口

3.1 请求信息

接入方调用本接口，获取海马云游戏服务相关PCU信息。显示接入方总量的实例限额、总使用量及游戏包/游戏渠道的使用情况。

表3-1 请求信息说明

请求参数（payload）示例：

{
  ·"conditions": {
    "pkgName": "com.tencent.tmgp.sgame",
    "appChannel": "test"
  }
}

表3-2 请求参数说明

表3-3 PcuInfoRequest结构说明

表3-4 conditions结构说明

3.2 响应报文

响应代码示例如下所示。

• 无查询条件：

  {
      "code": 0,
      "details": {
          "date": "2020-11-05 10:54:42",
          "hsnTotal": 77,
          "inServiceNum": 10
      }
  }

• 查询appChannel：

  {
      "code": 0,
      "details": {
          "channelDetails": [
          {
              "appChannel": "100_ad_1",
              "gameDetails": [
              {
                  "inServiceNum": 2,
                  "name1": "贪吃蛇大作战®",
                  "pkgName": "com.wepie.snake.game_demo"
              },
              {
                  "inServiceNum": 3,
                  "name": "开心消消乐®",
                  "pkgName": "com.happyelements.AndroidAnimal"
              }
              ]
          }
          ],
          "date": "2020-11-05 10:54:42",
          "hsnTotal": 77,
          "inServiceNum": 10
      }
  }

• 查询pkgName：

  {
      "code": 0,
      "details": {
          "channelDetails": [
          {
              "appChannel": "100_ad_1",
              "gameDetails": [
              {
                  "inServiceNum": 2,
                  "name": "贪吃蛇大作战®",
                  "pkgName": "com.wepie.snake.game_demo"
              }
              ]
          },
          {
              "appChannel": "100_ad_2",
              "gameDetails": [
              {
                  "inServiceNum": 2,
                  "name": "贪吃蛇大作战®",
                  "pkgName": "com.wepie.snake.game_demo"
              }
              ]
          }
          ],
          "date": "2020-11-05 10:54:42",
          "hsnTotal": 77,
          "inServiceNum": 10
      }
  }

• 查询pkgName+appChannel：

  {
      "code": 0,
      "details": {
          "channelDetails": [
          {
              "appChannel": "100_ad_1",
              "gameDetails": [
              {
                  "inServiceNum": 2,
                  "name": "贪吃蛇大作战®",
                  "pkgName": "com.wepie.snake.game_demo"
              }
              ]
          }
          ],
          "date": "2020-11-05 10:54:42",
          "hsnTotal": 77,
          "inServiceNum": 10
      }
  }

表3-5 响应报文参数说明

表3-6 details结构说明

表3-7 channelDetails结构说明

表3-8 gameDetails结构说明

4 错误码

表4-1 错误码