调用CreateAppSessionBatchSync批量同步创建应用会话

批量创建应用会话，平台会按顺序调配资源，启动多个进程。

接口说明

当批量创建会话的个数不同时，时效性不同。最多一次批量创建 20 个。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
BatchId	string	是	自定义批量操作 ID。具有唯一性。说明支持 ASCII 字符，且不能超过 64 个字符。	6d4d****
AppInfos	array<object>	是	应用启动信息。
	object	是
CustomerSessionId	string	是	自定义会话 ID。说明支持 ASCII 字符，且不能超过 64 个字符。	1ADE0****
CustomUserId	string	否	自定义用户 ID。用于存档的读取和保存。最大长度不超过 64 个字符。说明当应用类型为`end_game`、`hand_game`时，本参数必填。	2YEF0****
AppId	string	是	应用 ID。	13027****
AppVersion	string	否	应用版本 ID。	35067****
ClientIp	string	否	业务的客户端 IP 地址。	192.168.XX.XX
SystemInfo	array<object>	否	系统信息。
	object	否
Key	string	否	目前支持自定义。取值为 utdid，表示设备 ID。可以帮助平台分析异常流量的特征和定位问题。	utdid
Value	string	否	Key 对应的取值。	OE0usD+AP****
StartParameters	array<object>	否	通用参数、业务定制参数。
	object	否
Key	string	否	目前支持的枚举值。取值为 startArgument，表示应用启动参数。	startArgument
Value	string	否	Key 对应的取值。	exampleValue
Tags	array<object>	否	自定义标签。
	object	否
Key	string	否	标签键。最长 64 个字符。	exampleTag
Value	string	否	Key 对应的取值。	exampleValue
ProjectId	string	否	项目 ID。	d9a8****
DistrictId	string	否	区域 ID。取值： huadong xinan huanan huabei huazhong	huadong
MatchRules	array<object>	否	资源匹配的规则信息，支持多个；规则越多找到合适资源的耗时越长。
	object	否
Type	string	否	规则类型。取值： in：存在指定 Key 和 Value 的资源会被命中。 notIn：不存在指定 Key 和 Value 的资源会被命中。	in
Key	string	否	资源提供的标签名称。取值： component：组件版本；指定组件版本时，只会用带有指定组件版本的资源启动会话。	component
Values	array	否	需要匹配的标签值。
	string	否	约定的标签值。	exampleTag
AdapterFileId	string	否	适配文件 ID。此功能灰度开放，如未约定使用请勿传入。	501716211209548966XXXX

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	46329898-489C-4E63-9BA1-C1DA5C5D0986
BatchId	string	批量操作 ID。	6d4d****
ResultList	array<object>	结果列表。
	object
CustomSessionId	string	自定义会话 ID。	1ADE0****
PlatformSessionId	string	平台会话 ID。	100****
AppId	string	应用 ID。	13027****
AppVersion	string	应用版本 ID。	35067****
BizInfo	object	业务信息。
Biz	object	业务结果信息。	authToken
Endpoints	array<object>	终端节点信息。
	object
Name	string	终端节点名称。	exampleName
AccessHost	string	终端节点 IP 地址。	127.0.X.X
AccessPort	string	终端节点端口。	8080
Type	string	终端节点类型。取值为 Native。	Native
DistrictId	string	区域 ID。取值： huadong xinan huanan huabei huazhong	huadong
Isp	string	运营商。取值： MOBILE：中国移动。 UNICOM：中国联通。 TELECOM：中国电信。 BGP：多线网络。	bgp
FailedList	array<object>	失败列表。
	object
CustomSessionId	string	自定义会话 ID。	1ADE0****
AppId	string	应用 ID。	100****
FailedInfo	object	失败信息。
ErrorMessage	string	错误码。	400
ErrorCode	string	错误描述。	App type not support.

示例

正常返回示例

JSON格式

{
  "RequestId": "46329898-489C-4E63-9BA1-C1DA5C5D0986",
  "BatchId": "6d4d****",
  "ResultList": [
    {
      "CustomSessionId": "1ADE0****",
      "PlatformSessionId": "100****",
      "AppId": "13027****",
      "AppVersion": "35067****",
      "BizInfo": {
        "Biz": {
          "test": "test",
          "test2": 1
        },
        "Endpoints": [
          {
            "Name": "exampleName",
            "AccessHost": "127.0.X.X",
            "AccessPort": "8080",
            "Type": "Native",
            "DistrictId": "huadong",
            "Isp": "bgp"
          }
        ]
      }
    }
  ],
  "FailedList": [
    {
      "CustomSessionId": "1ADE0****",
      "AppId": "100****",
      "FailedInfo": {
        "ErrorMessage": "400",
        "ErrorCode": "App type not support."
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史