tccli 3.0.1292.2__py2.py3-none-any.whl → 3.0.1293.2__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +3 -0
  3. tccli/services/advisor/v20200721/api.json +36 -36
  4. tccli/services/advisor/v20200721/examples.json +2 -2
  5. tccli/services/batch/v20170312/api.json +4 -4
  6. tccli/services/cam/v20190116/api.json +18 -18
  7. tccli/services/cdwpg/v20201230/api.json +114 -107
  8. tccli/services/cdwpg/v20201230/examples.json +3 -3
  9. tccli/services/chc/__init__.py +4 -0
  10. tccli/services/chc/chc_client.py +2062 -0
  11. tccli/services/chc/v20230418/api.json +5728 -0
  12. tccli/services/chc/v20230418/examples.json +293 -0
  13. tccli/services/ckafka/v20190819/api.json +34 -34
  14. tccli/services/ckafka/v20190819/examples.json +1 -1
  15. tccli/services/cls/v20201016/api.json +198 -198
  16. tccli/services/cls/v20201016/examples.json +1 -1
  17. tccli/services/dbbrain/dbbrain_client.py +240 -28
  18. tccli/services/dbbrain/v20191016/api.json +5 -5
  19. tccli/services/dbbrain/v20210527/api.json +473 -10
  20. tccli/services/dbbrain/v20210527/examples.json +32 -0
  21. tccli/services/domain/v20180808/api.json +2 -2
  22. tccli/services/ecdn/ecdn_client.py +7 -431
  23. tccli/services/ecdn/v20191012/api.json +0 -574
  24. tccli/services/ecdn/v20191012/examples.json +0 -64
  25. tccli/services/ess/v20201111/api.json +12 -3
  26. tccli/services/essbasic/v20210526/api.json +9 -0
  27. tccli/services/gs/gs_client.py +1778 -29
  28. tccli/services/gs/v20191118/api.json +2618 -163
  29. tccli/services/gs/v20191118/examples.json +264 -0
  30. tccli/services/hai/v20230812/api.json +22 -22
  31. tccli/services/lke/v20231130/api.json +14 -14
  32. tccli/services/lke/v20231130/examples.json +2 -2
  33. tccli/services/mmps/v20200710/api.json +12 -12
  34. tccli/services/mqtt/v20240516/api.json +13 -13
  35. tccli/services/mqtt/v20240516/examples.json +1 -1
  36. tccli/services/tchd/v20230306/api.json +5 -5
  37. tccli/services/tcr/v20190924/api.json +22 -22
  38. tccli/services/tdmq/v20200217/api.json +1 -1
  39. tccli/services/thpc/v20220401/api.json +3 -3
  40. tccli/services/thpc/v20230321/api.json +45 -33
  41. tccli/services/tione/v20211111/api.json +40 -1
  42. tccli/services/tke/v20180525/api.json +29 -29
  43. tccli/services/vpc/v20170312/api.json +1 -1
  44. tccli/services/wedata/v20210820/api.json +61 -1
  45. tccli/services/wedata/v20210820/examples.json +2 -8
  46. {tccli-3.0.1292.2.dist-info → tccli-3.0.1293.2.dist-info}/METADATA +2 -2
  47. {tccli-3.0.1292.2.dist-info → tccli-3.0.1293.2.dist-info}/RECORD +50 -46
  48. {tccli-3.0.1292.2.dist-info → tccli-3.0.1293.2.dist-info}/WHEEL +0 -0
  49. {tccli-3.0.1292.2.dist-info → tccli-3.0.1293.2.dist-info}/entry_points.txt +0 -0
  50. {tccli-3.0.1292.2.dist-info → tccli-3.0.1293.2.dist-info}/license_files/LICENSE +0 -0
@@ -1,5 +1,54 @@
1
1
  {
2
2
  "actions": {
3
+ "ConnectAndroidInstance": {
4
+ "document": "连接安卓实例",
5
+ "input": "ConnectAndroidInstanceRequest",
6
+ "name": "连接安卓实例",
7
+ "output": "ConnectAndroidInstanceResponse",
8
+ "status": "online"
9
+ },
10
+ "CopyAndroidInstance": {
11
+ "document": "复制安卓实例:\n1. 排除和包含文件只能指定/data下的文件,不指定时复制整个/data目录\n2. 源实例和目的实例必须在同一区域\n3. 复制时,源实例和目的实例都会停机,复制完后实例会自动启动\n4. 复制时会产生大量内网流量,请限制并发",
12
+ "input": "CopyAndroidInstanceRequest",
13
+ "name": "复制安卓实例",
14
+ "output": "CopyAndroidInstanceResponse",
15
+ "status": "online"
16
+ },
17
+ "CreateAndroidInstanceImage": {
18
+ "document": "创建安卓实例镜像",
19
+ "input": "CreateAndroidInstanceImageRequest",
20
+ "name": "创建安卓实例镜像",
21
+ "output": "CreateAndroidInstanceImageResponse",
22
+ "status": "online"
23
+ },
24
+ "CreateAndroidInstanceLabel": {
25
+ "document": "创建安卓实例",
26
+ "input": "CreateAndroidInstanceLabelRequest",
27
+ "name": "创建安卓实例标签",
28
+ "output": "CreateAndroidInstanceLabelResponse",
29
+ "status": "online"
30
+ },
31
+ "CreateAndroidInstanceSSH": {
32
+ "document": "创建安卓实例 SSH 连接",
33
+ "input": "CreateAndroidInstanceSSHRequest",
34
+ "name": "创建安卓实例SSH连接",
35
+ "output": "CreateAndroidInstanceSSHResponse",
36
+ "status": "online"
37
+ },
38
+ "CreateAndroidInstanceWebShell": {
39
+ "document": "创建安卓实例 WebShell 连接",
40
+ "input": "CreateAndroidInstanceWebShellRequest",
41
+ "name": "创建安卓实例 WebShell 连接",
42
+ "output": "CreateAndroidInstanceWebShellResponse",
43
+ "status": "online"
44
+ },
45
+ "CreateAndroidInstances": {
46
+ "document": "创建安卓实例",
47
+ "input": "CreateAndroidInstancesRequest",
48
+ "name": "创建安卓实例",
49
+ "output": "CreateAndroidInstancesResponse",
50
+ "status": "online"
51
+ },
3
52
  "CreateSession": {
4
53
  "document": "创建会话",
5
54
  "input": "CreateSessionRequest",
@@ -7,6 +56,62 @@
7
56
  "output": "CreateSessionResponse",
8
57
  "status": "online"
9
58
  },
59
+ "DeleteAndroidInstanceImages": {
60
+ "document": "删除安卓实例镜像",
61
+ "input": "DeleteAndroidInstanceImagesRequest",
62
+ "name": "删除安卓实例镜像",
63
+ "output": "DeleteAndroidInstanceImagesResponse",
64
+ "status": "online"
65
+ },
66
+ "DeleteAndroidInstanceLabel": {
67
+ "document": "创建安卓实例",
68
+ "input": "DeleteAndroidInstanceLabelRequest",
69
+ "name": "删除安卓实例标签",
70
+ "output": "DeleteAndroidInstanceLabelResponse",
71
+ "status": "online"
72
+ },
73
+ "DescribeAndroidApps": {
74
+ "document": "查询安卓应用信息",
75
+ "input": "DescribeAndroidAppsRequest",
76
+ "name": "查询安卓应用信息",
77
+ "output": "DescribeAndroidAppsResponse",
78
+ "status": "online"
79
+ },
80
+ "DescribeAndroidInstanceApps": {
81
+ "document": "查询安卓实例应用",
82
+ "input": "DescribeAndroidInstanceAppsRequest",
83
+ "name": "查询安卓实例应用",
84
+ "output": "DescribeAndroidInstanceAppsResponse",
85
+ "status": "online"
86
+ },
87
+ "DescribeAndroidInstanceImages": {
88
+ "document": "查询安卓实例镜像",
89
+ "input": "DescribeAndroidInstanceImagesRequest",
90
+ "name": "查询安卓实例镜像列表",
91
+ "output": "DescribeAndroidInstanceImagesResponse",
92
+ "status": "online"
93
+ },
94
+ "DescribeAndroidInstanceLabels": {
95
+ "document": "创建安卓实例",
96
+ "input": "DescribeAndroidInstanceLabelsRequest",
97
+ "name": "查询安卓实例标签",
98
+ "output": "DescribeAndroidInstanceLabelsResponse",
99
+ "status": "online"
100
+ },
101
+ "DescribeAndroidInstanceTasksStatus": {
102
+ "document": "查询安卓实例任务状态",
103
+ "input": "DescribeAndroidInstanceTasksStatusRequest",
104
+ "name": "查询安卓实例任务状态",
105
+ "output": "DescribeAndroidInstanceTasksStatusResponse",
106
+ "status": "online"
107
+ },
108
+ "DescribeAndroidInstances": {
109
+ "document": "查询安卓实例",
110
+ "input": "DescribeAndroidInstancesRequest",
111
+ "name": "查询安卓实例",
112
+ "output": "DescribeAndroidInstancesResponse",
113
+ "status": "online"
114
+ },
10
115
  "DescribeInstancesCount": {
11
116
  "document": "获取并发总数和运行数",
12
117
  "input": "DescribeInstancesCountRequest",
@@ -14,6 +119,76 @@
14
119
  "output": "DescribeInstancesCountResponse",
15
120
  "status": "online"
16
121
  },
122
+ "DestroyAndroidInstances": {
123
+ "document": "销毁安卓实例",
124
+ "input": "DestroyAndroidInstancesRequest",
125
+ "name": "销毁安卓实例",
126
+ "output": "DestroyAndroidInstancesResponse",
127
+ "status": "online"
128
+ },
129
+ "ExecuteCommandOnAndroidInstances": {
130
+ "document": "在安卓实例上异步执行命令,命令输出结果如果内容过长会被截断",
131
+ "input": "ExecuteCommandOnAndroidInstancesRequest",
132
+ "name": "在安卓实例上异步执行命令",
133
+ "output": "ExecuteCommandOnAndroidInstancesResponse",
134
+ "status": "online"
135
+ },
136
+ "InstallAndroidInstancesApp": {
137
+ "document": "安装安卓实例应用",
138
+ "input": "InstallAndroidInstancesAppRequest",
139
+ "name": "安装安卓实例应用",
140
+ "output": "InstallAndroidInstancesAppResponse",
141
+ "status": "online"
142
+ },
143
+ "ModifyAndroidInstanceInformation": {
144
+ "document": "修改安卓实例的信息",
145
+ "input": "ModifyAndroidInstanceInformationRequest",
146
+ "name": "修改安卓实例信息",
147
+ "output": "ModifyAndroidInstanceInformationResponse",
148
+ "status": "online"
149
+ },
150
+ "ModifyAndroidInstanceResolution": {
151
+ "document": "修改安卓实例分辨率。需要注意的是该接口可能导致正在运行的应用出现闪退,所以建议在实例维护时期才进行调用。",
152
+ "input": "ModifyAndroidInstanceResolutionRequest",
153
+ "name": "修改安卓实例分辨率",
154
+ "output": "ModifyAndroidInstanceResolutionResponse",
155
+ "status": "online"
156
+ },
157
+ "ModifyAndroidInstancesLabels": {
158
+ "document": "修改安卓实例分辨率。需要注意的是该接口可能导致正在运行的应用出现闪退,所以建议在实例维护时期才进行调用。",
159
+ "input": "ModifyAndroidInstancesLabelsRequest",
160
+ "name": "批量修改安卓实例的标签",
161
+ "output": "ModifyAndroidInstancesLabelsResponse",
162
+ "status": "online"
163
+ },
164
+ "ModifyAndroidInstancesUserId": {
165
+ "document": "批量修改安卓实例的用户ID",
166
+ "input": "ModifyAndroidInstancesUserIdRequest",
167
+ "name": "批量修改安卓实例的用户ID",
168
+ "output": "ModifyAndroidInstancesUserIdResponse",
169
+ "status": "online"
170
+ },
171
+ "RebootAndroidInstances": {
172
+ "document": "重启安卓实例",
173
+ "input": "RebootAndroidInstancesRequest",
174
+ "name": "重启安卓实例",
175
+ "output": "RebootAndroidInstancesResponse",
176
+ "status": "online"
177
+ },
178
+ "ResetAndroidInstances": {
179
+ "document": "重置安卓实例",
180
+ "input": "ResetAndroidInstancesRequest",
181
+ "name": "重置安卓实例",
182
+ "output": "ResetAndroidInstancesResponse",
183
+ "status": "online"
184
+ },
185
+ "RestartAndroidInstancesApp": {
186
+ "document": "启动安卓实例应用",
187
+ "input": "RestartAndroidInstancesAppRequest",
188
+ "name": "重启安卓实例应用",
189
+ "output": "RestartAndroidInstancesAppResponse",
190
+ "status": "online"
191
+ },
17
192
  "SaveGameArchive": {
18
193
  "document": "保存游戏存档",
19
194
  "input": "SaveGameArchiveRequest",
@@ -21,6 +196,20 @@
21
196
  "output": "SaveGameArchiveResponse",
22
197
  "status": "online"
23
198
  },
199
+ "StartAndroidInstances": {
200
+ "document": "重启安卓实例",
201
+ "input": "StartAndroidInstancesRequest",
202
+ "name": "开机安卓实例",
203
+ "output": "StartAndroidInstancesResponse",
204
+ "status": "online"
205
+ },
206
+ "StartAndroidInstancesApp": {
207
+ "document": "启动安卓实例应用",
208
+ "input": "StartAndroidInstancesAppRequest",
209
+ "name": "启动安卓实例应用",
210
+ "output": "StartAndroidInstancesAppResponse",
211
+ "status": "online"
212
+ },
24
213
  "StartPublishStream": {
25
214
  "document": "开始云端推流",
26
215
  "input": "StartPublishStreamRequest",
@@ -35,6 +224,20 @@
35
224
  "output": "StartPublishStreamToCSSResponse",
36
225
  "status": "online"
37
226
  },
227
+ "StopAndroidInstances": {
228
+ "document": "重启安卓实例",
229
+ "input": "StopAndroidInstancesRequest",
230
+ "name": "关机安卓实例",
231
+ "output": "StopAndroidInstancesResponse",
232
+ "status": "online"
233
+ },
234
+ "StopAndroidInstancesApp": {
235
+ "document": "停止安卓实例应用",
236
+ "input": "StopAndroidInstancesAppRequest",
237
+ "name": "停止安卓实例应用",
238
+ "output": "StopAndroidInstancesAppResponse",
239
+ "status": "online"
240
+ },
38
241
  "StopGame": {
39
242
  "document": "强制退出游戏",
40
243
  "input": "StopGameRequest",
@@ -56,12 +259,40 @@
56
259
  "output": "SwitchGameArchiveResponse",
57
260
  "status": "online"
58
261
  },
262
+ "SyncAndroidInstanceImage": {
263
+ "document": "同步安卓实例镜像",
264
+ "input": "SyncAndroidInstanceImageRequest",
265
+ "name": "同步安卓实例镜像",
266
+ "output": "SyncAndroidInstanceImageResponse",
267
+ "status": "online"
268
+ },
269
+ "SyncExecuteCommandOnAndroidInstances": {
270
+ "document": "在安卓实例上同步执行命令,仅支持1秒内可以返回结果的命令,例如:ls、cd。同时执行的实例数量不能过多,否则可能云api返回超时。不支持超过1秒无法返回或无法自主结束的命令,例如:top、vim,执行结果最大1KB",
271
+ "input": "SyncExecuteCommandOnAndroidInstancesRequest",
272
+ "name": "在安卓实例上同步执行命令",
273
+ "output": "SyncExecuteCommandOnAndroidInstancesResponse",
274
+ "status": "online"
275
+ },
59
276
  "TrylockWorker": {
60
277
  "document": "尝试锁定机器",
61
278
  "input": "TrylockWorkerRequest",
62
279
  "name": "尝试锁定机器",
63
280
  "output": "TrylockWorkerResponse",
64
281
  "status": "online"
282
+ },
283
+ "UninstallAndroidInstancesApp": {
284
+ "document": "卸载安卓实例应用",
285
+ "input": "UninstallAndroidInstancesAppRequest",
286
+ "name": "卸载安卓实例应用",
287
+ "output": "UninstallAndroidInstancesAppResponse",
288
+ "status": "online"
289
+ },
290
+ "UploadFileToAndroidInstances": {
291
+ "document": "上传文件到安卓实例",
292
+ "input": "UploadFileToAndroidInstancesRequest",
293
+ "name": "上传文件到安卓实例",
294
+ "output": "UploadFileToAndroidInstancesResponse",
295
+ "status": "online"
65
296
  }
66
297
  },
67
298
  "metadata": {
@@ -71,279 +302,2174 @@
71
302
  "serviceShortName": "gs"
72
303
  },
73
304
  "objects": {
74
- "CreateSessionRequest": {
75
- "document": "CreateSession请求参数结构体",
305
+ "AndroidApp": {
306
+ "document": "安卓应用",
76
307
  "members": [
77
308
  {
78
309
  "disabled": false,
79
- "document": "唯一用户身份标识,由业务方自定义,平台不予理解。(可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成;在用户重连时应保持UserId不变)",
80
- "example": "xyz789",
310
+ "document": "安卓应用 Id",
311
+ "example": "apk-sdfddc",
81
312
  "member": "string",
82
- "name": "UserId",
83
- "required": true,
84
- "type": "string"
313
+ "name": "AndroidAppId",
314
+ "output_required": true,
315
+ "type": "string",
316
+ "value_allowed_null": false
85
317
  },
86
318
  {
87
319
  "disabled": false,
88
- "document": "【已废弃】只在TrylockWorker时生效",
89
- "example": "game-abcd1234",
320
+ "document": "安卓应用名称\n注意:此字段可能返回 null,表示取不到有效值。",
321
+ "example": "猫耳",
90
322
  "member": "string",
91
- "name": "GameId",
92
- "required": true,
93
- "type": "string"
323
+ "name": "Name",
324
+ "output_required": true,
325
+ "type": "string",
326
+ "value_allowed_null": true
94
327
  },
95
328
  {
96
329
  "disabled": false,
97
- "document": "【已废弃】只在TrylockWorker时生效",
98
- "example": "ap-guangzhou",
330
+ "document": "安卓应用状态(上架、下架)",
331
+ "example": "ONLINE|OFFLINE",
99
332
  "member": "string",
100
- "name": "GameRegion",
101
- "required": false,
102
- "type": "string"
333
+ "name": "State",
334
+ "output_required": true,
335
+ "type": "string",
336
+ "value_allowed_null": false
103
337
  },
104
338
  {
105
339
  "disabled": false,
106
- "document": "游戏参数",
107
- "example": "StartFor=1",
340
+ "document": "安卓应用版本列表\n注意:此字段可能返回 null,表示取不到有效值。",
341
+ "example": "[{\"ver-a1b2c3\",\"NORMAL\"}]",
342
+ "member": "AndroidAppVersionInfo",
343
+ "name": "AndroidAppVersionInfo",
344
+ "output_required": false,
345
+ "type": "list",
346
+ "value_allowed_null": true
347
+ },
348
+ {
349
+ "disabled": false,
350
+ "document": "安卓应用创建时间",
351
+ "example": "\"2022-02-15T01:51:55.786Z\"\t",
352
+ "member": "datetime_iso",
353
+ "name": "CreateTime",
354
+ "output_required": true,
355
+ "type": "string",
356
+ "value_allowed_null": false
357
+ }
358
+ ],
359
+ "usage": "out"
360
+ },
361
+ "AndroidAppVersionInfo": {
362
+ "document": "安卓应用版本信息",
363
+ "members": [
364
+ {
365
+ "disabled": false,
366
+ "document": "安卓应用版本",
367
+ "example": "\"ver-a1b2c3\"",
108
368
  "member": "string",
109
- "name": "GameParas",
110
- "required": false,
111
- "type": "string"
369
+ "name": "AndroidAppVersion",
370
+ "output_required": true,
371
+ "type": "string",
372
+ "value_allowed_null": false
112
373
  },
113
374
  {
114
375
  "disabled": false,
115
- "document": "客户端session信息,从JSSDK请求中获得。特殊的,当 RunMode 参数为 RunWithoutClient 时,该字段可以为空",
116
- "example": "e30=",
376
+ "document": "安卓应用版本创建状态(NORMAL:无、UPLOADING:上传中、\nCREATING: 创建中、\nCREATE_FAIL:创建失败、CREATE_SUCCESS:创建成功)",
377
+ "example": "\"NORMAL|UPLOADING|CREATING|CREATE_FAIL|CREATE_SUCCESS\"",
117
378
  "member": "string",
118
- "name": "ClientSession",
119
- "required": false,
120
- "type": "string"
379
+ "name": "State",
380
+ "output_required": true,
381
+ "type": "string",
382
+ "value_allowed_null": false
121
383
  },
122
384
  {
123
385
  "disabled": false,
124
- "document": "分辨率,,可设置为1080p或720p或1920x1080格式",
125
- "example": "1080p",
386
+ "document": "安卓应用版本创建时间",
387
+ "example": "\"2022-02-15T01:51:55.786Z\"",
388
+ "member": "datetime_iso",
389
+ "name": "CreateTime",
390
+ "output_required": true,
391
+ "type": "string",
392
+ "value_allowed_null": false
393
+ }
394
+ ],
395
+ "usage": "out"
396
+ },
397
+ "AndroidInstance": {
398
+ "document": "安卓实例信息",
399
+ "members": [
400
+ {
401
+ "disabled": false,
402
+ "document": "实例 ID",
403
+ "example": "cai-abcd1234",
126
404
  "member": "string",
127
- "name": "Resolution",
405
+ "name": "AndroidInstanceId",
406
+ "output_required": true,
128
407
  "required": false,
129
- "type": "string"
408
+ "type": "string",
409
+ "value_allowed_null": false
130
410
  },
131
411
  {
132
412
  "disabled": false,
133
- "document": "背景图url,格式为png或jpeg,宽高1920*1080",
134
- "example": "http://ip:port/test.png",
413
+ "document": "实例所在区域",
414
+ "example": "ap-guangzhou",
135
415
  "member": "string",
136
- "name": "ImageUrl",
416
+ "name": "AndroidInstanceRegion",
417
+ "output_required": true,
137
418
  "required": false,
138
- "type": "string"
419
+ "type": "string",
420
+ "value_allowed_null": false
139
421
  },
140
422
  {
141
423
  "disabled": false,
142
- "document": "【已废弃】",
143
- "example": "1",
144
- "member": "uint64",
145
- "name": "SetNo",
424
+ "document": "实例可用区\n注意:此字段可能返回 null,表示取不到有效值。",
425
+ "example": "ap-guangzhou-3",
426
+ "member": "string",
427
+ "name": "AndroidInstanceZone",
428
+ "output_required": false,
146
429
  "required": false,
147
- "type": "int"
430
+ "type": "string",
431
+ "value_allowed_null": true
148
432
  },
149
433
  {
150
434
  "disabled": false,
151
- "document": "【已废弃】",
152
- "example": "2",
153
- "member": "uint64",
154
- "name": "Bitrate",
435
+ "document": "实例状态:INITIALIZING,NORMAL,PROCESSING",
436
+ "example": "NORMAL",
437
+ "member": "string",
438
+ "name": "State",
439
+ "output_required": true,
155
440
  "required": false,
156
- "type": "int"
441
+ "type": "string",
442
+ "value_allowed_null": false
157
443
  },
158
444
  {
159
445
  "disabled": false,
160
- "document": "单位Mbps,动态调整最大码率建议值,会按实际情况调整",
161
- "example": "4",
162
- "member": "uint64",
163
- "name": "MaxBitrate",
446
+ "document": "实例规格",
447
+ "example": "A3",
448
+ "member": "string",
449
+ "name": "AndroidInstanceType",
450
+ "output_required": true,
164
451
  "required": false,
165
- "type": "int"
452
+ "type": "string",
453
+ "value_allowed_null": false
166
454
  },
167
455
  {
168
456
  "disabled": false,
169
- "document": "单位Mbps,动态调整最小码率建议值,会按实际情况调整",
170
- "example": "2",
171
- "member": "uint64",
172
- "name": "MinBitrate",
457
+ "document": "实例镜像 ID\n注意:此字段可能返回 null,表示取不到有效值。",
458
+ "example": "image-abcd1234",
459
+ "member": "string",
460
+ "name": "AndroidInstanceImageId",
461
+ "output_required": false,
173
462
  "required": false,
174
- "type": "int"
463
+ "type": "string",
464
+ "value_allowed_null": true
175
465
  },
176
466
  {
177
467
  "disabled": false,
178
- "document": "帧率,可设置为30、45、60、90、120、144",
179
- "example": "60",
468
+ "document": "分辨率宽度",
469
+ "example": "1080",
180
470
  "member": "uint64",
181
- "name": "Fps",
471
+ "name": "Width",
472
+ "output_required": false,
182
473
  "required": false,
183
- "type": "int"
474
+ "type": "int",
475
+ "value_allowed_null": false
184
476
  },
185
477
  {
186
478
  "disabled": false,
187
- "document": "【必选】用户IP,用户客户端的公网IP,用于就近调度,不填将严重影响用户体验",
188
- "example": "125.127.178.228",
189
- "member": "string",
190
- "name": "UserIp",
479
+ "document": "分辨率高度",
480
+ "example": "1920",
481
+ "member": "uint64",
482
+ "name": "Height",
483
+ "output_required": false,
191
484
  "required": false,
192
- "type": "string"
485
+ "type": "int",
486
+ "value_allowed_null": false
193
487
  },
194
488
  {
195
489
  "disabled": false,
196
- "document": "【已废弃】优化项,便于客户灰度开启新的优化项,默认为0",
197
- "example": "0",
198
- "member": "uint64",
199
- "name": "Optimization",
490
+ "document": "宿主机 ID",
491
+ "example": "RK123",
492
+ "member": "string",
493
+ "name": "HostSerialNumber",
494
+ "output_required": false,
200
495
  "required": false,
201
- "type": "int"
496
+ "type": "string",
497
+ "value_allowed_null": false
202
498
  },
203
499
  {
204
500
  "disabled": false,
205
- "document": "【互动云游】游戏主机用户ID",
206
- "example": "abc123",
501
+ "document": "分组 ID",
502
+ "example": "aig-1234abcd",
207
503
  "member": "string",
208
- "name": "HostUserId",
504
+ "name": "AndroidInstanceGroupId",
505
+ "output_required": false,
209
506
  "required": false,
210
- "type": "string"
507
+ "type": "string",
508
+ "value_allowed_null": false
211
509
  },
212
510
  {
213
511
  "disabled": false,
214
- "document": "【互动云游】角色;Player表示玩家;Viewer表示观察者",
215
- "example": "Player",
216
- "member": "string",
217
- "name": "Role",
512
+ "document": "标签列表",
513
+ "example": "",
514
+ "member": "AndroidInstanceLabel",
515
+ "name": "AndroidInstanceLabels",
516
+ "output_required": false,
218
517
  "required": false,
219
- "type": "string"
518
+ "type": "list",
519
+ "value_allowed_null": false
220
520
  },
221
521
  {
222
522
  "disabled": false,
223
- "document": "游戏相关参数",
224
- "example": "{\"Key\": \"Value\"}",
523
+ "document": "名称",
524
+ "example": "testname",
225
525
  "member": "string",
226
- "name": "GameContext",
526
+ "name": "Name",
527
+ "output_required": false,
227
528
  "required": false,
228
- "type": "string"
529
+ "type": "string",
530
+ "value_allowed_null": false
229
531
  },
230
532
  {
231
533
  "disabled": false,
232
- "document": "云端运行模式。\nRunWithoutClient:允许无客户端连接的情况下仍保持云端 App 运行\n默认值(空):要求必须有客户端连接才会保持云端 App 运行。",
233
- "example": "RunWithoutClient",
534
+ "document": "用户ID",
535
+ "example": "user123",
234
536
  "member": "string",
235
- "name": "RunMode",
537
+ "name": "UserId",
538
+ "output_required": false,
236
539
  "required": false,
237
- "type": "string"
540
+ "type": "string",
541
+ "value_allowed_null": false
238
542
  }
239
543
  ],
240
- "type": "object"
544
+ "usage": "both"
241
545
  },
242
- "CreateSessionResponse": {
243
- "document": "CreateSession返回参数结构体",
546
+ "AndroidInstanceAppInfo": {
547
+ "document": "安卓实例应用信息",
244
548
  "members": [
245
549
  {
246
550
  "disabled": false,
247
- "document": "服务端session信息,返回给JSSDK",
248
- "example": "e30=",
551
+ "document": "应用id\n注意:此字段可能返回 null,表示取不到有效值。",
552
+ "example": "apk-i37e2134",
249
553
  "member": "string",
250
- "name": "ServerSession",
554
+ "name": "AndroidAppId",
251
555
  "output_required": true,
556
+ "required": false,
252
557
  "type": "string",
253
- "value_allowed_null": false
558
+ "value_allowed_null": true
254
559
  },
255
560
  {
256
561
  "disabled": false,
257
- "document": "【已废弃】",
258
- "example": "1",
562
+ "document": "应用名称\n注意:此字段可能返回 null,表示取不到有效值。",
563
+ "example": "testapp",
259
564
  "member": "string",
260
- "name": "RoleNumber",
565
+ "name": "Name",
261
566
  "output_required": true,
567
+ "required": false,
262
568
  "type": "string",
263
- "value_allowed_null": false
569
+ "value_allowed_null": true
264
570
  },
265
571
  {
266
572
  "disabled": false,
267
- "document": "【互动云游】角色;Player表示玩家;Viewer表示观察者",
268
- "example": "Player",
573
+ "document": "应用版本\n注意:此字段可能返回 null,表示取不到有效值。",
574
+ "example": "1",
269
575
  "member": "string",
270
- "name": "Role",
576
+ "name": "AndroidAppVersion",
271
577
  "output_required": true,
578
+ "required": false,
272
579
  "type": "string",
273
- "value_allowed_null": false
580
+ "value_allowed_null": true
274
581
  },
275
- {
276
- "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
277
- "member": "string",
278
- "name": "RequestId",
279
- "type": "string"
280
- }
281
- ],
282
- "type": "object"
283
- },
284
- "DescribeInstancesCountRequest": {
285
- "document": "DescribeInstancesCount请求参数结构体",
286
- "members": [
287
582
  {
288
583
  "disabled": false,
289
- "document": "游戏ID",
290
- "example": "game-abcd1234",
584
+ "document": "应用包名",
585
+ "example": "test.com",
291
586
  "member": "string",
292
- "name": "GameId",
587
+ "name": "PackageName",
588
+ "output_required": false,
293
589
  "required": false,
590
+ "type": "string",
591
+ "value_allowed_null": false
592
+ },
593
+ {
594
+ "disabled": false,
595
+ "document": "应用包版本",
596
+ "example": "9.1.50",
597
+ "member": "string",
598
+ "name": "PackageVersion",
599
+ "output_required": false,
600
+ "required": false,
601
+ "type": "string",
602
+ "value_allowed_null": false
603
+ },
604
+ {
605
+ "disabled": false,
606
+ "document": "应用包标签",
607
+ "example": "QQ",
608
+ "member": "string",
609
+ "name": "PackageLabel",
610
+ "output_required": false,
611
+ "required": false,
612
+ "type": "string",
613
+ "value_allowed_null": false
614
+ }
615
+ ],
616
+ "usage": "both"
617
+ },
618
+ "AndroidInstanceImage": {
619
+ "document": "安卓实例镜像信息",
620
+ "members": [
621
+ {
622
+ "disabled": false,
623
+ "document": "镜像 ID\n注意:此字段可能返回 null,表示取不到有效值。",
624
+ "example": "image-abcd1234",
625
+ "member": "string",
626
+ "name": "AndroidInstanceImageId",
627
+ "output_required": true,
628
+ "type": "string",
629
+ "value_allowed_null": true
630
+ },
631
+ {
632
+ "disabled": false,
633
+ "document": "镜像名称,由业务方自定义,仅用于展示\n注意:此字段可能返回 null,表示取不到有效值。",
634
+ "example": "img-123",
635
+ "member": "string",
636
+ "name": "AndroidInstanceImageName",
637
+ "output_required": true,
638
+ "type": "string",
639
+ "value_allowed_null": true
640
+ },
641
+ {
642
+ "disabled": false,
643
+ "document": "镜像状态\n注意:此字段可能返回 null,表示取不到有效值。",
644
+ "example": "NORMAL",
645
+ "member": "string",
646
+ "name": "AndroidInstanceImageState",
647
+ "output_required": true,
648
+ "type": "string",
649
+ "value_allowed_null": true
650
+ },
651
+ {
652
+ "disabled": false,
653
+ "document": "镜像可用区\n注意:此字段可能返回 null,表示取不到有效值。",
654
+ "example": "ap-guangzhou-3",
655
+ "member": "string",
656
+ "name": "AndroidInstanceImageZone",
657
+ "output_required": false,
658
+ "type": "string",
659
+ "value_allowed_null": true
660
+ }
661
+ ],
662
+ "usage": "out"
663
+ },
664
+ "AndroidInstanceLabel": {
665
+ "document": "安卓实例标签",
666
+ "members": [
667
+ {
668
+ "disabled": false,
669
+ "document": "标签键",
670
+ "example": "key1",
671
+ "member": "string",
672
+ "name": "Key",
673
+ "output_required": true,
674
+ "required": true,
675
+ "type": "string",
676
+ "value_allowed_null": false
677
+ },
678
+ {
679
+ "disabled": false,
680
+ "document": "标签值",
681
+ "example": "value1",
682
+ "member": "string",
683
+ "name": "Value",
684
+ "output_required": true,
685
+ "required": true,
686
+ "type": "string",
687
+ "value_allowed_null": false
688
+ }
689
+ ],
690
+ "usage": "both"
691
+ },
692
+ "AndroidInstanceTask": {
693
+ "document": "安卓实例任务信息",
694
+ "members": [
695
+ {
696
+ "disabled": false,
697
+ "document": "任务ID\n注意:此字段可能返回 null,表示取不到有效值。",
698
+ "example": "无",
699
+ "member": "string",
700
+ "name": "TaskId",
701
+ "output_required": true,
702
+ "type": "string",
703
+ "value_allowed_null": true
704
+ },
705
+ {
706
+ "disabled": false,
707
+ "document": "实例ID\n注意:此字段可能返回 null,表示取不到有效值。",
708
+ "example": "无",
709
+ "member": "string",
710
+ "name": "AndroidInstanceId",
711
+ "output_required": true,
712
+ "type": "string",
713
+ "value_allowed_null": true
714
+ }
715
+ ],
716
+ "usage": "out"
717
+ },
718
+ "AndroidInstanceTaskStatus": {
719
+ "document": "安卓实例任务状态信息",
720
+ "members": [
721
+ {
722
+ "disabled": false,
723
+ "document": "任务ID",
724
+ "example": "无",
725
+ "member": "string",
726
+ "name": "TaskId",
727
+ "output_required": true,
728
+ "required": false,
729
+ "type": "string",
730
+ "value_allowed_null": false
731
+ },
732
+ {
733
+ "disabled": false,
734
+ "document": "任务状态:SUCCESS,FAILED,PROCESSING,PENDING,CANCELED",
735
+ "example": "SUCCESS",
736
+ "member": "string",
737
+ "name": "Status",
738
+ "output_required": true,
739
+ "required": false,
740
+ "type": "string",
741
+ "value_allowed_null": false
742
+ },
743
+ {
744
+ "disabled": false,
745
+ "document": "实例ID",
746
+ "example": "无",
747
+ "member": "string",
748
+ "name": "AndroidInstanceId",
749
+ "output_required": true,
750
+ "required": false,
751
+ "type": "string",
752
+ "value_allowed_null": false
753
+ },
754
+ {
755
+ "disabled": false,
756
+ "document": "任务执行结果描述,针对某些任务,可以是可解析的 json\n注意:此字段可能返回 null,表示取不到有效值。",
757
+ "example": "无",
758
+ "member": "string",
759
+ "name": "TaskResult",
760
+ "output_required": false,
761
+ "required": false,
762
+ "type": "string",
763
+ "value_allowed_null": true
764
+ }
765
+ ],
766
+ "usage": "both"
767
+ },
768
+ "ConnectAndroidInstanceRequest": {
769
+ "document": "ConnectAndroidInstance请求参数结构体",
770
+ "members": [
771
+ {
772
+ "disabled": false,
773
+ "document": "用户Session信息",
774
+ "example": "无",
775
+ "member": "string",
776
+ "name": "ClientSession",
777
+ "required": true,
778
+ "type": "string"
779
+ },
780
+ {
781
+ "disabled": false,
782
+ "document": "实例ID",
783
+ "example": "无",
784
+ "member": "string",
785
+ "name": "AndroidInstanceId",
786
+ "required": true,
787
+ "type": "string"
788
+ },
789
+ {
790
+ "disabled": false,
791
+ "document": "用户IP,用户客户端的公网IP,用于选择最佳网络链路",
792
+ "example": "125.127.178.228",
793
+ "member": "string",
794
+ "name": "UserIp",
795
+ "required": true,
796
+ "type": "string"
797
+ }
798
+ ],
799
+ "type": "object"
800
+ },
801
+ "ConnectAndroidInstanceResponse": {
802
+ "document": "ConnectAndroidInstance返回参数结构体",
803
+ "members": [
804
+ {
805
+ "disabled": false,
806
+ "document": "服务端session信息",
807
+ "example": "无",
808
+ "member": "string",
809
+ "name": "ServerSession",
810
+ "output_required": true,
811
+ "type": "string",
812
+ "value_allowed_null": false
813
+ },
814
+ {
815
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
816
+ "member": "string",
817
+ "name": "RequestId",
818
+ "type": "string"
819
+ }
820
+ ],
821
+ "type": "object"
822
+ },
823
+ "CopyAndroidInstanceRequest": {
824
+ "document": "CopyAndroidInstance请求参数结构体",
825
+ "members": [
826
+ {
827
+ "disabled": false,
828
+ "document": "源安卓实例 ID",
829
+ "example": "cai-1234abcd",
830
+ "member": "string",
831
+ "name": "SourceAndroidInstanceId",
832
+ "required": true,
833
+ "type": "string"
834
+ },
835
+ {
836
+ "disabled": false,
837
+ "document": "目的安卓实例 ID",
838
+ "example": "cai-abcd1234",
839
+ "member": "string",
840
+ "name": "TargetAndroidInstanceId",
841
+ "required": true,
842
+ "type": "string"
843
+ },
844
+ {
845
+ "disabled": false,
846
+ "document": "包含的路径,支持仅含一个通配符*,通配符不能出现在路径开始",
847
+ "example": "[\"/data/data/misc/*.prop\"]",
848
+ "member": "string",
849
+ "name": "Includes",
850
+ "required": false,
851
+ "type": "list"
852
+ },
853
+ {
854
+ "disabled": false,
855
+ "document": "需要排除路径,支持仅含一个通配符*,通配符不能出现在路径开始",
856
+ "example": "[\"/data/media/*\"]",
857
+ "member": "string",
858
+ "name": "Excludes",
859
+ "required": false,
860
+ "type": "list"
861
+ }
862
+ ],
863
+ "type": "object"
864
+ },
865
+ "CopyAndroidInstanceResponse": {
866
+ "document": "CopyAndroidInstance返回参数结构体",
867
+ "members": [
868
+ {
869
+ "disabled": false,
870
+ "document": "任务ID",
871
+ "example": "6a440fe6-1261-4036-b18f-5f861820640a",
872
+ "member": "string",
873
+ "name": "TaskId",
874
+ "output_required": true,
875
+ "type": "string",
876
+ "value_allowed_null": false
877
+ },
878
+ {
879
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
880
+ "member": "string",
881
+ "name": "RequestId",
882
+ "type": "string"
883
+ }
884
+ ],
885
+ "type": "object"
886
+ },
887
+ "CreateAndroidInstanceImageRequest": {
888
+ "document": "CreateAndroidInstanceImage请求参数结构体",
889
+ "members": [
890
+ {
891
+ "disabled": false,
892
+ "document": "安卓实例镜像名称",
893
+ "example": "image-abc",
894
+ "member": "string",
895
+ "name": "AndroidInstanceImageName",
896
+ "required": true,
897
+ "type": "string"
898
+ },
899
+ {
900
+ "disabled": false,
901
+ "document": "安卓实例 ID",
902
+ "example": "cai-abcd1234",
903
+ "member": "string",
904
+ "name": "AndroidInstanceId",
905
+ "required": true,
906
+ "type": "string"
907
+ }
908
+ ],
909
+ "type": "object"
910
+ },
911
+ "CreateAndroidInstanceImageResponse": {
912
+ "document": "CreateAndroidInstanceImage返回参数结构体",
913
+ "members": [
914
+ {
915
+ "disabled": false,
916
+ "document": "安卓实例镜像 ID\n注意:此字段可能返回 null,表示取不到有效值。",
917
+ "example": "image-abc",
918
+ "member": "string",
919
+ "name": "AndroidInstanceImageId",
920
+ "output_required": false,
921
+ "type": "string",
922
+ "value_allowed_null": true
923
+ },
924
+ {
925
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
926
+ "member": "string",
927
+ "name": "RequestId",
928
+ "type": "string"
929
+ }
930
+ ],
931
+ "type": "object"
932
+ },
933
+ "CreateAndroidInstanceLabelRequest": {
934
+ "document": "CreateAndroidInstanceLabel请求参数结构体",
935
+ "members": [
936
+ {
937
+ "disabled": false,
938
+ "document": "标签键",
939
+ "example": "key1",
940
+ "member": "string",
941
+ "name": "Key",
942
+ "required": true,
943
+ "type": "string"
944
+ },
945
+ {
946
+ "disabled": false,
947
+ "document": "标签值",
948
+ "example": "value1",
949
+ "member": "string",
950
+ "name": "Value",
951
+ "required": false,
952
+ "type": "string"
953
+ }
954
+ ],
955
+ "type": "object"
956
+ },
957
+ "CreateAndroidInstanceLabelResponse": {
958
+ "document": "CreateAndroidInstanceLabel返回参数结构体",
959
+ "members": [
960
+ {
961
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
962
+ "member": "string",
963
+ "name": "RequestId",
964
+ "type": "string"
965
+ }
966
+ ],
967
+ "type": "object"
968
+ },
969
+ "CreateAndroidInstanceSSHRequest": {
970
+ "document": "CreateAndroidInstanceSSH请求参数结构体",
971
+ "members": [
972
+ {
973
+ "disabled": false,
974
+ "document": "实例ID",
975
+ "example": "cai-123456-abc",
976
+ "member": "string",
977
+ "name": "AndroidInstanceId",
978
+ "required": true,
979
+ "type": "string"
980
+ },
981
+ {
982
+ "disabled": false,
983
+ "document": "连接过期时间,最长可设置7天",
984
+ "example": "2021-05-04T11:00:00Z",
985
+ "member": "string",
986
+ "name": "ExpiredTime",
987
+ "required": true,
988
+ "type": "string"
989
+ }
990
+ ],
991
+ "type": "object"
992
+ },
993
+ "CreateAndroidInstanceSSHResponse": {
994
+ "document": "CreateAndroidInstanceSSH返回参数结构体",
995
+ "members": [
996
+ {
997
+ "disabled": false,
998
+ "document": "连接私钥,需要保存为文件形式,例如 private_key.pem",
999
+ "example": "-----BEGIN OPENSSH PRIVATE KEY-----",
1000
+ "member": "string",
1001
+ "name": "PrivateKey",
1002
+ "output_required": false,
1003
+ "type": "string",
1004
+ "value_allowed_null": false
1005
+ },
1006
+ {
1007
+ "disabled": false,
1008
+ "document": "用户名称",
1009
+ "example": "root",
1010
+ "member": "string",
1011
+ "name": "UserName",
1012
+ "output_required": false,
1013
+ "type": "string",
1014
+ "value_allowed_null": false
1015
+ },
1016
+ {
1017
+ "disabled": false,
1018
+ "document": "连接地址",
1019
+ "example": "10.0.0.1",
1020
+ "member": "string",
1021
+ "name": "HostName",
1022
+ "output_required": false,
1023
+ "type": "string",
1024
+ "value_allowed_null": false
1025
+ },
1026
+ {
1027
+ "disabled": false,
1028
+ "document": "连接端口",
1029
+ "example": "12222",
1030
+ "member": "int64",
1031
+ "name": "Port",
1032
+ "output_required": false,
1033
+ "type": "int",
1034
+ "value_allowed_null": false
1035
+ },
1036
+ {
1037
+ "disabled": false,
1038
+ "document": "连接参考命令",
1039
+ "example": "ssh -i private_key.pem -p 12222 root@10.0.0.1",
1040
+ "member": "string",
1041
+ "name": "ConnectCommand",
1042
+ "output_required": false,
1043
+ "type": "string",
1044
+ "value_allowed_null": false
1045
+ },
1046
+ {
1047
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1048
+ "member": "string",
1049
+ "name": "RequestId",
1050
+ "type": "string"
1051
+ }
1052
+ ],
1053
+ "type": "object"
1054
+ },
1055
+ "CreateAndroidInstanceWebShellRequest": {
1056
+ "document": "CreateAndroidInstanceWebShell请求参数结构体",
1057
+ "members": [
1058
+ {
1059
+ "disabled": false,
1060
+ "document": "实例 ID",
1061
+ "example": "cai-123456",
1062
+ "member": "string",
1063
+ "name": "AndroidInstanceId",
1064
+ "required": true,
1065
+ "type": "string"
1066
+ }
1067
+ ],
1068
+ "type": "object"
1069
+ },
1070
+ "CreateAndroidInstanceWebShellResponse": {
1071
+ "document": "CreateAndroidInstanceWebShell返回参数结构体",
1072
+ "members": [
1073
+ {
1074
+ "disabled": false,
1075
+ "document": "鉴权密钥",
1076
+ "example": "e4fc61c4eb1dcca50",
1077
+ "member": "string",
1078
+ "name": "Key",
1079
+ "output_required": false,
1080
+ "type": "string",
1081
+ "value_allowed_null": false
1082
+ },
1083
+ {
1084
+ "disabled": false,
1085
+ "document": "连接地址",
1086
+ "example": "ap-shenzhen-1.webssh.crtrcloud.com",
1087
+ "member": "string",
1088
+ "name": "Address",
1089
+ "output_required": false,
1090
+ "type": "string",
1091
+ "value_allowed_null": false
1092
+ },
1093
+ {
1094
+ "disabled": false,
1095
+ "document": "连接区域",
1096
+ "example": "ap-shenzhen-1",
1097
+ "member": "string",
1098
+ "name": "Zone",
1099
+ "output_required": false,
1100
+ "type": "string",
1101
+ "value_allowed_null": false
1102
+ },
1103
+ {
1104
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1105
+ "member": "string",
1106
+ "name": "RequestId",
1107
+ "type": "string"
1108
+ }
1109
+ ],
1110
+ "type": "object"
1111
+ },
1112
+ "CreateAndroidInstancesRequest": {
1113
+ "document": "CreateAndroidInstances请求参数结构体",
1114
+ "members": [
1115
+ {
1116
+ "disabled": false,
1117
+ "document": "安卓实例可用区。\nap-guangzhou-3:广州三区\nap-shenzhen-1:深圳一区\nap-xian-ec-1:西安一区\nap-hangzhou-ec-1:杭州一区",
1118
+ "example": "ap-shenzhen-1",
1119
+ "member": "string",
1120
+ "name": "Zone",
1121
+ "required": true,
1122
+ "type": "string"
1123
+ },
1124
+ {
1125
+ "disabled": false,
1126
+ "document": "安卓实例类型。\nA1:单开\nA2:双开\nA3:三开\nA4:四开\nA5:五开\nA6:六开",
1127
+ "example": "A3",
1128
+ "member": "string",
1129
+ "name": "Type",
1130
+ "required": true,
1131
+ "type": "string"
1132
+ },
1133
+ {
1134
+ "disabled": false,
1135
+ "document": "当 HostSerialNumbers 不为空时,该参数表示每个宿主机要创建的安卓实例数量;\n当 HostSerialNumbers 为空时,该参数表示要创建安卓实例的总数量,最大值为 100。",
1136
+ "example": "1",
1137
+ "member": "uint64",
1138
+ "name": "Number",
1139
+ "required": true,
1140
+ "type": "int"
1141
+ },
1142
+ {
1143
+ "disabled": false,
1144
+ "document": "宿主机 ID 列表。可以指定宿主机 ID 进行创建;也可以不指定由系统自动分配宿主机。",
1145
+ "example": "[\"RK123\"]",
1146
+ "member": "string",
1147
+ "name": "HostSerialNumbers",
1148
+ "required": false,
1149
+ "type": "list"
1150
+ },
1151
+ {
1152
+ "disabled": false,
1153
+ "document": "镜像 ID。如果不填,将使用默认的系统镜像",
1154
+ "example": "image-abc",
1155
+ "member": "string",
1156
+ "name": "ImageId",
1157
+ "required": false,
1158
+ "type": "string"
1159
+ }
1160
+ ],
1161
+ "type": "object"
1162
+ },
1163
+ "CreateAndroidInstancesResponse": {
1164
+ "document": "CreateAndroidInstances返回参数结构体",
1165
+ "members": [
1166
+ {
1167
+ "disabled": false,
1168
+ "document": "安卓实例 ID 列表",
1169
+ "example": "[\"abc\", \"def\"]",
1170
+ "member": "string",
1171
+ "name": "AndroidInstanceIds",
1172
+ "output_required": true,
1173
+ "type": "list",
1174
+ "value_allowed_null": false
1175
+ },
1176
+ {
1177
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1178
+ "member": "string",
1179
+ "name": "RequestId",
1180
+ "type": "string"
1181
+ }
1182
+ ],
1183
+ "type": "object"
1184
+ },
1185
+ "CreateSessionRequest": {
1186
+ "document": "CreateSession请求参数结构体",
1187
+ "members": [
1188
+ {
1189
+ "disabled": false,
1190
+ "document": "唯一用户身份标识,由业务方自定义,平台不予理解。(可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成;在用户重连时应保持UserId不变)",
1191
+ "example": "xyz789",
1192
+ "member": "string",
1193
+ "name": "UserId",
1194
+ "required": true,
1195
+ "type": "string"
1196
+ },
1197
+ {
1198
+ "disabled": false,
1199
+ "document": "【已废弃】只在TrylockWorker时生效",
1200
+ "example": "game-abcd1234",
1201
+ "member": "string",
1202
+ "name": "GameId",
1203
+ "required": true,
1204
+ "type": "string"
1205
+ },
1206
+ {
1207
+ "disabled": false,
1208
+ "document": "【已废弃】只在TrylockWorker时生效",
1209
+ "example": "ap-guangzhou",
1210
+ "member": "string",
1211
+ "name": "GameRegion",
1212
+ "required": false,
1213
+ "type": "string"
1214
+ },
1215
+ {
1216
+ "disabled": false,
1217
+ "document": "游戏参数",
1218
+ "example": "StartFor=1",
1219
+ "member": "string",
1220
+ "name": "GameParas",
1221
+ "required": false,
1222
+ "type": "string"
1223
+ },
1224
+ {
1225
+ "disabled": false,
1226
+ "document": "客户端session信息,从JSSDK请求中获得。特殊的,当 RunMode 参数为 RunWithoutClient 时,该字段可以为空",
1227
+ "example": "e30=",
1228
+ "member": "string",
1229
+ "name": "ClientSession",
1230
+ "required": false,
1231
+ "type": "string"
1232
+ },
1233
+ {
1234
+ "disabled": false,
1235
+ "document": "分辨率,,可设置为1080p或720p或1920x1080格式",
1236
+ "example": "1080p",
1237
+ "member": "string",
1238
+ "name": "Resolution",
1239
+ "required": false,
1240
+ "type": "string"
1241
+ },
1242
+ {
1243
+ "disabled": false,
1244
+ "document": "背景图url,格式为png或jpeg,宽高1920*1080",
1245
+ "example": "http://ip:port/test.png",
1246
+ "member": "string",
1247
+ "name": "ImageUrl",
1248
+ "required": false,
1249
+ "type": "string"
1250
+ },
1251
+ {
1252
+ "disabled": false,
1253
+ "document": "【已废弃】",
1254
+ "example": "1",
1255
+ "member": "uint64",
1256
+ "name": "SetNo",
1257
+ "required": false,
1258
+ "type": "int"
1259
+ },
1260
+ {
1261
+ "disabled": false,
1262
+ "document": "【已废弃】",
1263
+ "example": "2",
1264
+ "member": "uint64",
1265
+ "name": "Bitrate",
1266
+ "required": false,
1267
+ "type": "int"
1268
+ },
1269
+ {
1270
+ "disabled": false,
1271
+ "document": "单位Mbps,动态调整最大码率建议值,会按实际情况调整",
1272
+ "example": "4",
1273
+ "member": "uint64",
1274
+ "name": "MaxBitrate",
1275
+ "required": false,
1276
+ "type": "int"
1277
+ },
1278
+ {
1279
+ "disabled": false,
1280
+ "document": "单位Mbps,动态调整最小码率建议值,会按实际情况调整",
1281
+ "example": "2",
1282
+ "member": "uint64",
1283
+ "name": "MinBitrate",
1284
+ "required": false,
1285
+ "type": "int"
1286
+ },
1287
+ {
1288
+ "disabled": false,
1289
+ "document": "帧率,可设置为30、45、60、90、120、144",
1290
+ "example": "60",
1291
+ "member": "uint64",
1292
+ "name": "Fps",
1293
+ "required": false,
1294
+ "type": "int"
1295
+ },
1296
+ {
1297
+ "disabled": false,
1298
+ "document": "【必选】用户IP,用户客户端的公网IP,用于就近调度,不填将严重影响用户体验",
1299
+ "example": "125.127.178.228",
1300
+ "member": "string",
1301
+ "name": "UserIp",
1302
+ "required": false,
1303
+ "type": "string"
1304
+ },
1305
+ {
1306
+ "disabled": false,
1307
+ "document": "【已废弃】优化项,便于客户灰度开启新的优化项,默认为0",
1308
+ "example": "0",
1309
+ "member": "uint64",
1310
+ "name": "Optimization",
1311
+ "required": false,
1312
+ "type": "int"
1313
+ },
1314
+ {
1315
+ "disabled": false,
1316
+ "document": "【互动云游】游戏主机用户ID",
1317
+ "example": "abc123",
1318
+ "member": "string",
1319
+ "name": "HostUserId",
1320
+ "required": false,
1321
+ "type": "string"
1322
+ },
1323
+ {
1324
+ "disabled": false,
1325
+ "document": "【互动云游】角色;Player表示玩家;Viewer表示观察者",
1326
+ "example": "Player",
1327
+ "member": "string",
1328
+ "name": "Role",
1329
+ "required": false,
1330
+ "type": "string"
1331
+ },
1332
+ {
1333
+ "disabled": false,
1334
+ "document": "游戏相关参数",
1335
+ "example": "{\"Key\": \"Value\"}",
1336
+ "member": "string",
1337
+ "name": "GameContext",
1338
+ "required": false,
1339
+ "type": "string"
1340
+ },
1341
+ {
1342
+ "disabled": false,
1343
+ "document": "云端运行模式。\nRunWithoutClient:允许无客户端连接的情况下仍保持云端 App 运行\n默认值(空):要求必须有客户端连接才会保持云端 App 运行。",
1344
+ "example": "RunWithoutClient",
1345
+ "member": "string",
1346
+ "name": "RunMode",
1347
+ "required": false,
1348
+ "type": "string"
1349
+ }
1350
+ ],
1351
+ "type": "object"
1352
+ },
1353
+ "CreateSessionResponse": {
1354
+ "document": "CreateSession返回参数结构体",
1355
+ "members": [
1356
+ {
1357
+ "disabled": false,
1358
+ "document": "服务端session信息,返回给JSSDK",
1359
+ "example": "e30=",
1360
+ "member": "string",
1361
+ "name": "ServerSession",
1362
+ "output_required": true,
1363
+ "type": "string",
1364
+ "value_allowed_null": false
1365
+ },
1366
+ {
1367
+ "disabled": false,
1368
+ "document": "【已废弃】",
1369
+ "example": "1",
1370
+ "member": "string",
1371
+ "name": "RoleNumber",
1372
+ "output_required": true,
1373
+ "type": "string",
1374
+ "value_allowed_null": false
1375
+ },
1376
+ {
1377
+ "disabled": false,
1378
+ "document": "【互动云游】角色;Player表示玩家;Viewer表示观察者",
1379
+ "example": "Player",
1380
+ "member": "string",
1381
+ "name": "Role",
1382
+ "output_required": true,
1383
+ "type": "string",
1384
+ "value_allowed_null": false
1385
+ },
1386
+ {
1387
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1388
+ "member": "string",
1389
+ "name": "RequestId",
1390
+ "type": "string"
1391
+ }
1392
+ ],
1393
+ "type": "object"
1394
+ },
1395
+ "DeleteAndroidInstanceImagesRequest": {
1396
+ "document": "DeleteAndroidInstanceImages请求参数结构体",
1397
+ "members": [
1398
+ {
1399
+ "disabled": false,
1400
+ "document": "镜像 ID 列表",
1401
+ "example": "无",
1402
+ "member": "string",
1403
+ "name": "AndroidInstanceImageIds",
1404
+ "required": true,
1405
+ "type": "list"
1406
+ }
1407
+ ],
1408
+ "type": "object"
1409
+ },
1410
+ "DeleteAndroidInstanceImagesResponse": {
1411
+ "document": "DeleteAndroidInstanceImages返回参数结构体",
1412
+ "members": [
1413
+ {
1414
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1415
+ "member": "string",
1416
+ "name": "RequestId",
1417
+ "type": "string"
1418
+ }
1419
+ ],
1420
+ "type": "object"
1421
+ },
1422
+ "DeleteAndroidInstanceLabelRequest": {
1423
+ "document": "DeleteAndroidInstanceLabel请求参数结构体",
1424
+ "members": [
1425
+ {
1426
+ "disabled": false,
1427
+ "document": "标签键",
1428
+ "example": "key1",
1429
+ "member": "string",
1430
+ "name": "Key",
1431
+ "required": true,
1432
+ "type": "string"
1433
+ },
1434
+ {
1435
+ "disabled": false,
1436
+ "document": "标签值",
1437
+ "example": "value1",
1438
+ "member": "string",
1439
+ "name": "Value",
1440
+ "required": false,
1441
+ "type": "string"
1442
+ }
1443
+ ],
1444
+ "type": "object"
1445
+ },
1446
+ "DeleteAndroidInstanceLabelResponse": {
1447
+ "document": "DeleteAndroidInstanceLabel返回参数结构体",
1448
+ "members": [
1449
+ {
1450
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1451
+ "member": "string",
1452
+ "name": "RequestId",
1453
+ "type": "string"
1454
+ }
1455
+ ],
1456
+ "type": "object"
1457
+ },
1458
+ "DescribeAndroidAppsRequest": {
1459
+ "document": "DescribeAndroidApps请求参数结构体",
1460
+ "members": [
1461
+ {
1462
+ "disabled": false,
1463
+ "document": "分页偏移",
1464
+ "example": "0",
1465
+ "member": "int64",
1466
+ "name": "Offset",
1467
+ "required": false,
1468
+ "type": "int"
1469
+ },
1470
+ {
1471
+ "disabled": false,
1472
+ "document": "每页数量",
1473
+ "example": "10",
1474
+ "member": "int64",
1475
+ "name": "Limit",
1476
+ "required": false,
1477
+ "type": "int"
1478
+ },
1479
+ {
1480
+ "disabled": false,
1481
+ "document": "应用ID数组",
1482
+ "example": "[\"xxx\"]",
1483
+ "member": "string",
1484
+ "name": "AndroidAppIds",
1485
+ "required": false,
1486
+ "type": "list"
1487
+ }
1488
+ ],
1489
+ "type": "object"
1490
+ },
1491
+ "DescribeAndroidAppsResponse": {
1492
+ "document": "DescribeAndroidApps返回参数结构体",
1493
+ "members": [
1494
+ {
1495
+ "disabled": false,
1496
+ "document": "安卓应用列表\n注意:此字段可能返回 null,表示取不到有效值。",
1497
+ "example": "无",
1498
+ "member": "AndroidApp",
1499
+ "name": "Apps",
1500
+ "output_required": false,
1501
+ "type": "list",
1502
+ "value_allowed_null": true
1503
+ },
1504
+ {
1505
+ "disabled": false,
1506
+ "document": "安卓应用列表长度",
1507
+ "example": "10",
1508
+ "member": "uint64",
1509
+ "name": "TotalCount",
1510
+ "output_required": true,
1511
+ "type": "int",
1512
+ "value_allowed_null": false
1513
+ },
1514
+ {
1515
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1516
+ "member": "string",
1517
+ "name": "RequestId",
1518
+ "type": "string"
1519
+ }
1520
+ ],
1521
+ "type": "object"
1522
+ },
1523
+ "DescribeAndroidInstanceAppsRequest": {
1524
+ "document": "DescribeAndroidInstanceApps请求参数结构体",
1525
+ "members": [
1526
+ {
1527
+ "disabled": false,
1528
+ "document": "实例ID",
1529
+ "example": "无",
1530
+ "member": "string",
1531
+ "name": "AndroidInstanceId",
1532
+ "required": true,
1533
+ "type": "string"
1534
+ }
1535
+ ],
1536
+ "type": "object"
1537
+ },
1538
+ "DescribeAndroidInstanceAppsResponse": {
1539
+ "document": "DescribeAndroidInstanceApps返回参数结构体",
1540
+ "members": [
1541
+ {
1542
+ "disabled": false,
1543
+ "document": "安卓应用列表\n注意:此字段可能返回 null,表示取不到有效值。",
1544
+ "example": "无",
1545
+ "member": "AndroidInstanceAppInfo",
1546
+ "name": "Apps",
1547
+ "output_required": true,
1548
+ "type": "list",
1549
+ "value_allowed_null": true
1550
+ },
1551
+ {
1552
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1553
+ "member": "string",
1554
+ "name": "RequestId",
1555
+ "type": "string"
1556
+ }
1557
+ ],
1558
+ "type": "object"
1559
+ },
1560
+ "DescribeAndroidInstanceImagesRequest": {
1561
+ "document": "DescribeAndroidInstanceImages请求参数结构体",
1562
+ "members": [
1563
+ {
1564
+ "disabled": false,
1565
+ "document": "镜像 ID 列表",
1566
+ "example": "[\"abc\"]",
1567
+ "member": "string",
1568
+ "name": "AndroidInstanceImageIds",
1569
+ "required": false,
1570
+ "type": "list"
1571
+ },
1572
+ {
1573
+ "disabled": false,
1574
+ "document": "偏移量,默认为0",
1575
+ "example": "0",
1576
+ "member": "uint64",
1577
+ "name": "Offset",
1578
+ "required": false,
1579
+ "type": "int"
1580
+ },
1581
+ {
1582
+ "disabled": false,
1583
+ "document": "限制量,默认为20,最大值为100",
1584
+ "example": "20",
1585
+ "member": "uint64",
1586
+ "name": "Limit",
1587
+ "required": false,
1588
+ "type": "int"
1589
+ }
1590
+ ],
1591
+ "type": "object"
1592
+ },
1593
+ "DescribeAndroidInstanceImagesResponse": {
1594
+ "document": "DescribeAndroidInstanceImages返回参数结构体",
1595
+ "members": [
1596
+ {
1597
+ "disabled": false,
1598
+ "document": "镜像总数\n注意:此字段可能返回 null,表示取不到有效值。",
1599
+ "example": "10",
1600
+ "member": "int64",
1601
+ "name": "Total",
1602
+ "output_required": true,
1603
+ "type": "int",
1604
+ "value_allowed_null": true
1605
+ },
1606
+ {
1607
+ "disabled": false,
1608
+ "document": "镜像列表\n注意:此字段可能返回 null,表示取不到有效值。",
1609
+ "example": "无",
1610
+ "member": "AndroidInstanceImage",
1611
+ "name": "AndroidInstanceImages",
1612
+ "output_required": false,
1613
+ "type": "list",
1614
+ "value_allowed_null": true
1615
+ },
1616
+ {
1617
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1618
+ "member": "string",
1619
+ "name": "RequestId",
1620
+ "type": "string"
1621
+ }
1622
+ ],
1623
+ "type": "object"
1624
+ },
1625
+ "DescribeAndroidInstanceLabelsRequest": {
1626
+ "document": "DescribeAndroidInstanceLabels请求参数结构体",
1627
+ "members": [
1628
+ {
1629
+ "disabled": false,
1630
+ "document": "标签键列表",
1631
+ "example": "[ \"key1\" ]",
1632
+ "member": "string",
1633
+ "name": "Keys",
1634
+ "required": false,
1635
+ "type": "list"
1636
+ },
1637
+ {
1638
+ "disabled": false,
1639
+ "document": "标签值列表",
1640
+ "example": "[ \"value1\" ]",
1641
+ "member": "string",
1642
+ "name": "Values",
1643
+ "required": false,
1644
+ "type": "list"
1645
+ },
1646
+ {
1647
+ "disabled": false,
1648
+ "document": "偏移量,默认为 0",
1649
+ "example": "0",
1650
+ "member": "int64",
1651
+ "name": "Offset",
1652
+ "required": false,
1653
+ "type": "int"
1654
+ },
1655
+ {
1656
+ "disabled": false,
1657
+ "document": "限制量,默认为20,最大值为100",
1658
+ "example": "50",
1659
+ "member": "int64",
1660
+ "name": "Limit",
1661
+ "required": false,
1662
+ "type": "int"
1663
+ }
1664
+ ],
1665
+ "type": "object"
1666
+ },
1667
+ "DescribeAndroidInstanceLabelsResponse": {
1668
+ "document": "DescribeAndroidInstanceLabels返回参数结构体",
1669
+ "members": [
1670
+ {
1671
+ "disabled": false,
1672
+ "document": "安卓实例标签总数",
1673
+ "example": "10",
1674
+ "member": "uint64",
1675
+ "name": "Total",
1676
+ "output_required": false,
1677
+ "type": "int",
1678
+ "value_allowed_null": false
1679
+ },
1680
+ {
1681
+ "disabled": false,
1682
+ "document": "安卓实例标签列表",
1683
+ "example": "无",
1684
+ "member": "AndroidInstanceLabel",
1685
+ "name": "Labels",
1686
+ "output_required": false,
1687
+ "type": "list",
1688
+ "value_allowed_null": false
1689
+ },
1690
+ {
1691
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1692
+ "member": "string",
1693
+ "name": "RequestId",
1694
+ "type": "string"
1695
+ }
1696
+ ],
1697
+ "type": "object"
1698
+ },
1699
+ "DescribeAndroidInstanceTasksStatusRequest": {
1700
+ "document": "DescribeAndroidInstanceTasksStatus请求参数结构体",
1701
+ "members": [
1702
+ {
1703
+ "disabled": false,
1704
+ "document": "任务ID列表",
1705
+ "example": "无",
1706
+ "member": "string",
1707
+ "name": "TaskIds",
1708
+ "required": true,
1709
+ "type": "list"
1710
+ }
1711
+ ],
1712
+ "type": "object"
1713
+ },
1714
+ "DescribeAndroidInstanceTasksStatusResponse": {
1715
+ "document": "DescribeAndroidInstanceTasksStatus返回参数结构体",
1716
+ "members": [
1717
+ {
1718
+ "disabled": false,
1719
+ "document": "任务状态集合\n注意:此字段可能返回 null,表示取不到有效值。",
1720
+ "example": "无",
1721
+ "member": "AndroidInstanceTaskStatus",
1722
+ "name": "TaskStatusSet",
1723
+ "output_required": true,
1724
+ "type": "list",
1725
+ "value_allowed_null": true
1726
+ },
1727
+ {
1728
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1729
+ "member": "string",
1730
+ "name": "RequestId",
1731
+ "type": "string"
1732
+ }
1733
+ ],
1734
+ "type": "object"
1735
+ },
1736
+ "DescribeAndroidInstancesRequest": {
1737
+ "document": "DescribeAndroidInstances请求参数结构体",
1738
+ "members": [
1739
+ {
1740
+ "disabled": false,
1741
+ "document": "偏移量,默认为 0",
1742
+ "example": "0",
1743
+ "member": "int64",
1744
+ "name": "Offset",
1745
+ "required": false,
1746
+ "type": "int"
1747
+ },
1748
+ {
1749
+ "disabled": false,
1750
+ "document": "限制量,默认为20,最大值为100",
1751
+ "example": "50",
1752
+ "member": "int64",
1753
+ "name": "Limit",
1754
+ "required": false,
1755
+ "type": "int"
1756
+ },
1757
+ {
1758
+ "disabled": false,
1759
+ "document": "实例ID。每次请求的实例的上限为100。",
1760
+ "example": "[ \"cai-abcd1234\" ]",
1761
+ "member": "string",
1762
+ "name": "AndroidInstanceIds",
1763
+ "required": false,
1764
+ "type": "list"
1765
+ },
1766
+ {
1767
+ "disabled": false,
1768
+ "document": "实例地域。目前还不支持按地域进行聚合查询",
1769
+ "example": "ap-beijing",
1770
+ "member": "string",
1771
+ "name": "AndroidInstanceRegion",
1772
+ "required": false,
1773
+ "type": "string"
1774
+ },
1775
+ {
1776
+ "disabled": false,
1777
+ "document": "实例可用区",
1778
+ "example": "ap-beijing-1",
1779
+ "member": "string",
1780
+ "name": "AndroidInstanceZone",
1781
+ "required": false,
1782
+ "type": "string"
1783
+ },
1784
+ {
1785
+ "disabled": false,
1786
+ "document": "实例分组 ID 列表",
1787
+ "example": "[ \"aig-1234abcd' ]",
1788
+ "member": "string",
1789
+ "name": "AndroidInstanceGroupIds",
1790
+ "required": false,
1791
+ "type": "list"
1792
+ },
1793
+ {
1794
+ "disabled": false,
1795
+ "document": "实例标签选择器",
1796
+ "example": "无",
1797
+ "member": "LabelRequirement",
1798
+ "name": "LabelSelector",
1799
+ "required": false,
1800
+ "type": "list"
1801
+ },
1802
+ {
1803
+ "disabled": false,
1804
+ "document": "字段过滤器。Filter 的 Name 有以下值:\nName:实例名称\nUserId:实例用户ID",
1805
+ "example": "无",
1806
+ "member": "Filter",
1807
+ "name": "Filters",
1808
+ "required": false,
1809
+ "type": "list"
1810
+ }
1811
+ ],
1812
+ "type": "object"
1813
+ },
1814
+ "DescribeAndroidInstancesResponse": {
1815
+ "document": "DescribeAndroidInstances返回参数结构体",
1816
+ "members": [
1817
+ {
1818
+ "disabled": false,
1819
+ "document": "实例总数量",
1820
+ "example": "无",
1821
+ "member": "int64",
1822
+ "name": "TotalCount",
1823
+ "output_required": true,
1824
+ "type": "int",
1825
+ "value_allowed_null": false
1826
+ },
1827
+ {
1828
+ "disabled": false,
1829
+ "document": "实例列表",
1830
+ "example": "无",
1831
+ "member": "AndroidInstance",
1832
+ "name": "AndroidInstances",
1833
+ "output_required": false,
1834
+ "type": "list",
1835
+ "value_allowed_null": false
1836
+ },
1837
+ {
1838
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1839
+ "member": "string",
1840
+ "name": "RequestId",
1841
+ "type": "string"
1842
+ }
1843
+ ],
1844
+ "type": "object"
1845
+ },
1846
+ "DescribeInstancesCountRequest": {
1847
+ "document": "DescribeInstancesCount请求参数结构体",
1848
+ "members": [
1849
+ {
1850
+ "disabled": false,
1851
+ "document": "游戏ID",
1852
+ "example": "game-abcd1234",
1853
+ "member": "string",
1854
+ "name": "GameId",
1855
+ "required": false,
1856
+ "type": "string"
1857
+ },
1858
+ {
1859
+ "disabled": false,
1860
+ "document": "实例分组ID",
1861
+ "example": "cgg-1234abcd",
1862
+ "member": "string",
1863
+ "name": "GroupId",
1864
+ "required": false,
1865
+ "type": "string"
1866
+ },
1867
+ {
1868
+ "disabled": false,
1869
+ "document": "游戏区域",
1870
+ "example": "ap-guangzhou",
1871
+ "member": "string",
1872
+ "name": "GameRegion",
1873
+ "required": false,
1874
+ "type": "string"
1875
+ },
1876
+ {
1877
+ "disabled": false,
1878
+ "document": "游戏类型。\nMOBILE:手游\nPC:默认值,端游",
1879
+ "example": "MOBILE",
1880
+ "member": "string",
1881
+ "name": "GameType",
1882
+ "required": false,
1883
+ "type": "string"
1884
+ }
1885
+ ],
1886
+ "type": "object"
1887
+ },
1888
+ "DescribeInstancesCountResponse": {
1889
+ "document": "DescribeInstancesCount返回参数结构体",
1890
+ "members": [
1891
+ {
1892
+ "disabled": false,
1893
+ "document": "客户的实例总数",
1894
+ "example": "590",
1895
+ "member": "uint64",
1896
+ "name": "Total",
1897
+ "type": "int",
1898
+ "value_allowed_null": false
1899
+ },
1900
+ {
1901
+ "disabled": false,
1902
+ "document": "客户的实例运行数",
1903
+ "example": "480",
1904
+ "member": "uint64",
1905
+ "name": "Running",
1906
+ "type": "int",
1907
+ "value_allowed_null": false
1908
+ },
1909
+ {
1910
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1911
+ "member": "string",
1912
+ "name": "RequestId",
1913
+ "type": "string"
1914
+ }
1915
+ ],
1916
+ "type": "object"
1917
+ },
1918
+ "DestroyAndroidInstancesRequest": {
1919
+ "document": "DestroyAndroidInstances请求参数结构体",
1920
+ "members": [
1921
+ {
1922
+ "disabled": false,
1923
+ "document": "安卓实例 ID 列表",
1924
+ "example": "[\"abc\", \"def\"]",
1925
+ "member": "string",
1926
+ "name": "AndroidInstanceIds",
1927
+ "required": true,
1928
+ "type": "list"
1929
+ }
1930
+ ],
1931
+ "type": "object"
1932
+ },
1933
+ "DestroyAndroidInstancesResponse": {
1934
+ "document": "DestroyAndroidInstances返回参数结构体",
1935
+ "members": [
1936
+ {
1937
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1938
+ "member": "string",
1939
+ "name": "RequestId",
1940
+ "type": "string"
1941
+ }
1942
+ ],
1943
+ "type": "object"
1944
+ },
1945
+ "ExecuteCommandOnAndroidInstancesRequest": {
1946
+ "document": "ExecuteCommandOnAndroidInstances请求参数结构体",
1947
+ "members": [
1948
+ {
1949
+ "disabled": false,
1950
+ "document": "安卓实例 ID 列表",
1951
+ "example": "[\"android_instance_id\"]",
1952
+ "member": "string",
1953
+ "name": "AndroidInstanceIds",
1954
+ "required": true,
1955
+ "type": "list"
1956
+ },
1957
+ {
1958
+ "disabled": false,
1959
+ "document": "shell 命令",
1960
+ "example": "ls -al; cat /etc/profile",
1961
+ "member": "string",
1962
+ "name": "Command",
1963
+ "required": true,
1964
+ "type": "string"
1965
+ }
1966
+ ],
1967
+ "type": "object"
1968
+ },
1969
+ "ExecuteCommandOnAndroidInstancesResponse": {
1970
+ "document": "ExecuteCommandOnAndroidInstances返回参数结构体",
1971
+ "members": [
1972
+ {
1973
+ "disabled": false,
1974
+ "document": "任务集合,可异步查询任务状态",
1975
+ "example": "无",
1976
+ "member": "AndroidInstanceTask",
1977
+ "name": "TaskSet",
1978
+ "output_required": true,
1979
+ "type": "list",
1980
+ "value_allowed_null": false
1981
+ },
1982
+ {
1983
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1984
+ "member": "string",
1985
+ "name": "RequestId",
1986
+ "type": "string"
1987
+ }
1988
+ ],
1989
+ "type": "object"
1990
+ },
1991
+ "Filter": {
1992
+ "document": "过滤",
1993
+ "members": [
1994
+ {
1995
+ "disabled": false,
1996
+ "document": "\"aaa\"",
1997
+ "example": "",
1998
+ "member": "string",
1999
+ "name": "Name",
2000
+ "required": true,
2001
+ "type": "string",
2002
+ "value_allowed_null": false
2003
+ },
2004
+ {
2005
+ "disabled": false,
2006
+ "document": "[\"bbb\", \"ccc\"]",
2007
+ "example": "",
2008
+ "member": "string",
2009
+ "name": "Values",
2010
+ "required": true,
2011
+ "type": "list",
2012
+ "value_allowed_null": false
2013
+ }
2014
+ ],
2015
+ "usage": "in"
2016
+ },
2017
+ "InstallAndroidInstancesAppRequest": {
2018
+ "document": "InstallAndroidInstancesApp请求参数结构体",
2019
+ "members": [
2020
+ {
2021
+ "disabled": false,
2022
+ "document": "实例ID",
2023
+ "example": "无",
2024
+ "member": "string",
2025
+ "name": "AndroidInstanceIds",
2026
+ "required": true,
2027
+ "type": "list"
2028
+ },
2029
+ {
2030
+ "disabled": false,
2031
+ "document": "应用ID",
2032
+ "example": "无",
2033
+ "member": "string",
2034
+ "name": "AndroidAppId",
2035
+ "required": true,
2036
+ "type": "string"
2037
+ },
2038
+ {
2039
+ "disabled": false,
2040
+ "document": "应用版本",
2041
+ "example": "无",
2042
+ "member": "string",
2043
+ "name": "AndroidAppVersion",
2044
+ "required": false,
2045
+ "type": "string"
2046
+ }
2047
+ ],
2048
+ "type": "object"
2049
+ },
2050
+ "InstallAndroidInstancesAppResponse": {
2051
+ "document": "InstallAndroidInstancesApp返回参数结构体",
2052
+ "members": [
2053
+ {
2054
+ "disabled": false,
2055
+ "document": "任务集合\n注意:此字段可能返回 null,表示取不到有效值。",
2056
+ "example": "无",
2057
+ "member": "AndroidInstanceTask",
2058
+ "name": "TaskSet",
2059
+ "output_required": true,
2060
+ "type": "list",
2061
+ "value_allowed_null": true
2062
+ },
2063
+ {
2064
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2065
+ "member": "string",
2066
+ "name": "RequestId",
2067
+ "type": "string"
2068
+ }
2069
+ ],
2070
+ "type": "object"
2071
+ },
2072
+ "LabelRequirement": {
2073
+ "document": "标签要求",
2074
+ "members": [
2075
+ {
2076
+ "disabled": false,
2077
+ "document": "标签键",
2078
+ "example": "key1",
2079
+ "member": "string",
2080
+ "name": "Key",
2081
+ "output_required": false,
2082
+ "required": true,
2083
+ "type": "string",
2084
+ "value_allowed_null": false
2085
+ },
2086
+ {
2087
+ "disabled": false,
2088
+ "document": "运算符类型。\nIN:要求对象的标签键 Key 对应的标签值需满足 Values 中的一个\nNOT_IN:要求对象的标签键 Key 对应的标签值不满足 Values 中的任何一个\nEXISTS:要求对象标签存在标签键 Key\nNOT_EXISTS: 要求对象标签不存在标签键 Key",
2089
+ "example": "IN",
2090
+ "member": "string",
2091
+ "name": "Operator",
2092
+ "output_required": false,
2093
+ "required": true,
2094
+ "type": "string",
2095
+ "value_allowed_null": false
2096
+ },
2097
+ {
2098
+ "disabled": false,
2099
+ "document": "标签值列表",
2100
+ "example": "[\"value1\"]",
2101
+ "member": "string",
2102
+ "name": "Values",
2103
+ "output_required": false,
2104
+ "required": false,
2105
+ "type": "list",
2106
+ "value_allowed_null": false
2107
+ }
2108
+ ],
2109
+ "usage": "both"
2110
+ },
2111
+ "ModifyAndroidInstanceInformationRequest": {
2112
+ "document": "ModifyAndroidInstanceInformation请求参数结构体",
2113
+ "members": [
2114
+ {
2115
+ "disabled": false,
2116
+ "document": "安卓实例 ID",
2117
+ "example": "cai-abcd1234",
2118
+ "member": "string",
2119
+ "name": "AndroidInstanceId",
2120
+ "required": true,
294
2121
  "type": "string"
295
2122
  },
296
2123
  {
297
2124
  "disabled": false,
298
- "document": "实例分组ID",
299
- "example": "cgg-1234abcd",
2125
+ "document": "实例名称",
2126
+ "example": "testname",
300
2127
  "member": "string",
301
- "name": "GroupId",
2128
+ "name": "Name",
302
2129
  "required": false,
303
2130
  "type": "string"
2131
+ }
2132
+ ],
2133
+ "type": "object"
2134
+ },
2135
+ "ModifyAndroidInstanceInformationResponse": {
2136
+ "document": "ModifyAndroidInstanceInformation返回参数结构体",
2137
+ "members": [
2138
+ {
2139
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2140
+ "member": "string",
2141
+ "name": "RequestId",
2142
+ "type": "string"
2143
+ }
2144
+ ],
2145
+ "type": "object"
2146
+ },
2147
+ "ModifyAndroidInstanceResolutionRequest": {
2148
+ "document": "ModifyAndroidInstanceResolution请求参数结构体",
2149
+ "members": [
2150
+ {
2151
+ "disabled": false,
2152
+ "document": "安卓实例 ID",
2153
+ "example": "cai-abcd1234",
2154
+ "member": "string",
2155
+ "name": "AndroidInstanceId",
2156
+ "required": true,
2157
+ "type": "string"
304
2158
  },
305
2159
  {
306
2160
  "disabled": false,
307
- "document": "游戏区域",
308
- "example": "ap-guangzhou",
2161
+ "document": "分辨率宽度",
2162
+ "example": "1080",
2163
+ "member": "uint64",
2164
+ "name": "Width",
2165
+ "required": true,
2166
+ "type": "int"
2167
+ },
2168
+ {
2169
+ "disabled": false,
2170
+ "document": "分辨率高度",
2171
+ "example": "1920",
2172
+ "member": "uint64",
2173
+ "name": "Height",
2174
+ "required": true,
2175
+ "type": "int"
2176
+ },
2177
+ {
2178
+ "disabled": false,
2179
+ "document": "每英寸像素点。如果不填,系统将会计算一个合理的数值。修改 DPI 可能会导致 App 异常退出,请谨慎使用!",
2180
+ "example": "320",
2181
+ "member": "uint64",
2182
+ "name": "DPI",
2183
+ "required": false,
2184
+ "type": "int"
2185
+ }
2186
+ ],
2187
+ "type": "object"
2188
+ },
2189
+ "ModifyAndroidInstanceResolutionResponse": {
2190
+ "document": "ModifyAndroidInstanceResolution返回参数结构体",
2191
+ "members": [
2192
+ {
2193
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
309
2194
  "member": "string",
310
- "name": "GameRegion",
2195
+ "name": "RequestId",
2196
+ "type": "string"
2197
+ }
2198
+ ],
2199
+ "type": "object"
2200
+ },
2201
+ "ModifyAndroidInstancesLabelsRequest": {
2202
+ "document": "ModifyAndroidInstancesLabels请求参数结构体",
2203
+ "members": [
2204
+ {
2205
+ "disabled": false,
2206
+ "document": "安卓实例 ID 列表",
2207
+ "example": "[ \"cai-abcd1234\" ]",
2208
+ "member": "string",
2209
+ "name": "AndroidInstanceIds",
2210
+ "required": true,
2211
+ "type": "list"
2212
+ },
2213
+ {
2214
+ "disabled": false,
2215
+ "document": "安卓实例标签列表",
2216
+ "example": "无",
2217
+ "member": "AndroidInstanceLabel",
2218
+ "name": "AndroidInstanceLabels",
2219
+ "required": true,
2220
+ "type": "list"
2221
+ },
2222
+ {
2223
+ "disabled": false,
2224
+ "document": "操作类型。ADD:标签键不存在的添加新标签,标签键存在的将覆盖原有标签REMOVE:根据标签键删除标签REPLACE:使用请求标签列表替换原来所有标签CLEAR:清除所有标签",
2225
+ "example": "ADD",
2226
+ "member": "string",
2227
+ "name": "Operation",
2228
+ "required": true,
2229
+ "type": "string"
2230
+ }
2231
+ ],
2232
+ "type": "object"
2233
+ },
2234
+ "ModifyAndroidInstancesLabelsResponse": {
2235
+ "document": "ModifyAndroidInstancesLabels返回参数结构体",
2236
+ "members": [
2237
+ {
2238
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2239
+ "member": "string",
2240
+ "name": "RequestId",
2241
+ "type": "string"
2242
+ }
2243
+ ],
2244
+ "type": "object"
2245
+ },
2246
+ "ModifyAndroidInstancesUserIdRequest": {
2247
+ "document": "ModifyAndroidInstancesUserId请求参数结构体",
2248
+ "members": [
2249
+ {
2250
+ "disabled": false,
2251
+ "document": "安卓实例 ID 列表",
2252
+ "example": "[ \"cai-abcd1234\" ]",
2253
+ "member": "string",
2254
+ "name": "AndroidInstanceIds",
2255
+ "required": true,
2256
+ "type": "list"
2257
+ },
2258
+ {
2259
+ "disabled": false,
2260
+ "document": "用户 ID",
2261
+ "example": "user123",
2262
+ "member": "string",
2263
+ "name": "UserId",
2264
+ "required": false,
2265
+ "type": "string"
2266
+ }
2267
+ ],
2268
+ "type": "object"
2269
+ },
2270
+ "ModifyAndroidInstancesUserIdResponse": {
2271
+ "document": "ModifyAndroidInstancesUserId返回参数结构体",
2272
+ "members": [
2273
+ {
2274
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2275
+ "member": "string",
2276
+ "name": "RequestId",
2277
+ "type": "string"
2278
+ }
2279
+ ],
2280
+ "type": "object"
2281
+ },
2282
+ "RebootAndroidInstancesRequest": {
2283
+ "document": "RebootAndroidInstances请求参数结构体",
2284
+ "members": [
2285
+ {
2286
+ "disabled": false,
2287
+ "document": "实例ID",
2288
+ "example": "无",
2289
+ "member": "string",
2290
+ "name": "AndroidInstanceIds",
2291
+ "required": true,
2292
+ "type": "list"
2293
+ }
2294
+ ],
2295
+ "type": "object"
2296
+ },
2297
+ "RebootAndroidInstancesResponse": {
2298
+ "document": "RebootAndroidInstances返回参数结构体",
2299
+ "members": [
2300
+ {
2301
+ "disabled": false,
2302
+ "document": "任务集合\n注意:此字段可能返回 null,表示取不到有效值。",
2303
+ "example": "无",
2304
+ "member": "AndroidInstanceTask",
2305
+ "name": "TaskSet",
2306
+ "output_required": true,
2307
+ "type": "list",
2308
+ "value_allowed_null": true
2309
+ },
2310
+ {
2311
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2312
+ "member": "string",
2313
+ "name": "RequestId",
2314
+ "type": "string"
2315
+ }
2316
+ ],
2317
+ "type": "object"
2318
+ },
2319
+ "ResetAndroidInstancesRequest": {
2320
+ "document": "ResetAndroidInstances请求参数结构体",
2321
+ "members": [
2322
+ {
2323
+ "disabled": false,
2324
+ "document": "实例ID列表",
2325
+ "example": "[\"abc\"]",
2326
+ "member": "string",
2327
+ "name": "AndroidInstanceIds",
2328
+ "required": true,
2329
+ "type": "list"
2330
+ },
2331
+ {
2332
+ "disabled": false,
2333
+ "document": "指定有效的镜像 ID。\n默认取值:默认使用当前镜像。",
2334
+ "example": "image-abc",
2335
+ "member": "string",
2336
+ "name": "AndroidInstanceImageId",
311
2337
  "required": false,
312
2338
  "type": "string"
313
2339
  },
314
2340
  {
315
2341
  "disabled": false,
316
- "document": "游戏类型。\nMOBILE:手游\nPC:默认值,端游",
317
- "example": "MOBILE",
2342
+ "document": "重置模式。在 AndroidInstanceImageId 不为空时才生效。\n\nCleanData:默认选项,清理系统属性和用户数据\nKeepSystemProperties:只保留系统属性\nKeepData: 保留系统属性和用户数据",
2343
+ "example": "CleanData",
2344
+ "member": "string",
2345
+ "name": "Mode",
2346
+ "required": false,
2347
+ "type": "string"
2348
+ }
2349
+ ],
2350
+ "type": "object"
2351
+ },
2352
+ "ResetAndroidInstancesResponse": {
2353
+ "document": "ResetAndroidInstances返回参数结构体",
2354
+ "members": [
2355
+ {
2356
+ "disabled": false,
2357
+ "document": "任务集合\n注意:此字段可能返回 null,表示取不到有效值。",
2358
+ "example": "无",
2359
+ "member": "AndroidInstanceTask",
2360
+ "name": "TaskSet",
2361
+ "output_required": true,
2362
+ "type": "list",
2363
+ "value_allowed_null": true
2364
+ },
2365
+ {
2366
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2367
+ "member": "string",
2368
+ "name": "RequestId",
2369
+ "type": "string"
2370
+ }
2371
+ ],
2372
+ "type": "object"
2373
+ },
2374
+ "RestartAndroidInstancesAppRequest": {
2375
+ "document": "RestartAndroidInstancesApp请求参数结构体",
2376
+ "members": [
2377
+ {
2378
+ "disabled": false,
2379
+ "document": "实例 ID 列表",
2380
+ "example": "[ \"cai-abcd1234\" ]",
2381
+ "member": "string",
2382
+ "name": "AndroidInstanceIds",
2383
+ "required": true,
2384
+ "type": "list"
2385
+ },
2386
+ {
2387
+ "disabled": false,
2388
+ "document": "应用包名",
2389
+ "example": "com.example.app",
2390
+ "member": "string",
2391
+ "name": "PackageName",
2392
+ "required": true,
2393
+ "type": "string"
2394
+ }
2395
+ ],
2396
+ "type": "object"
2397
+ },
2398
+ "RestartAndroidInstancesAppResponse": {
2399
+ "document": "RestartAndroidInstancesApp返回参数结构体",
2400
+ "members": [
2401
+ {
2402
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2403
+ "member": "string",
2404
+ "name": "RequestId",
2405
+ "type": "string"
2406
+ }
2407
+ ],
2408
+ "type": "object"
2409
+ },
2410
+ "SaveGameArchiveRequest": {
2411
+ "document": "SaveGameArchive请求参数结构体",
2412
+ "members": [
2413
+ {
2414
+ "disabled": false,
2415
+ "document": "游戏用户ID",
2416
+ "example": "1621578692",
2417
+ "member": "string",
2418
+ "name": "UserId",
2419
+ "required": true,
2420
+ "type": "string"
2421
+ },
2422
+ {
2423
+ "disabled": false,
2424
+ "document": "游戏ID",
2425
+ "example": "game-a7l8c3ab",
2426
+ "member": "string",
2427
+ "name": "GameId",
2428
+ "required": true,
2429
+ "type": "string"
2430
+ }
2431
+ ],
2432
+ "type": "object"
2433
+ },
2434
+ "SaveGameArchiveResponse": {
2435
+ "document": "SaveGameArchive返回参数结构体",
2436
+ "members": [
2437
+ {
2438
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2439
+ "member": "string",
2440
+ "name": "RequestId",
2441
+ "type": "string"
2442
+ }
2443
+ ],
2444
+ "type": "object"
2445
+ },
2446
+ "StartAndroidInstancesAppRequest": {
2447
+ "document": "StartAndroidInstancesApp请求参数结构体",
2448
+ "members": [
2449
+ {
2450
+ "disabled": false,
2451
+ "document": "实例 ID 列表",
2452
+ "example": "[ \"cai-abcd1234\" ]",
2453
+ "member": "string",
2454
+ "name": "AndroidInstanceIds",
2455
+ "required": true,
2456
+ "type": "list"
2457
+ },
2458
+ {
2459
+ "disabled": false,
2460
+ "document": "应用包名",
2461
+ "example": "com.example.app",
318
2462
  "member": "string",
319
- "name": "GameType",
320
- "required": false,
2463
+ "name": "PackageName",
2464
+ "required": true,
321
2465
  "type": "string"
322
2466
  }
323
2467
  ],
324
2468
  "type": "object"
325
2469
  },
326
- "DescribeInstancesCountResponse": {
327
- "document": "DescribeInstancesCount返回参数结构体",
2470
+ "StartAndroidInstancesAppResponse": {
2471
+ "document": "StartAndroidInstancesApp返回参数结构体",
328
2472
  "members": [
329
- {
330
- "disabled": false,
331
- "document": "客户的实例总数",
332
- "example": "590",
333
- "member": "uint64",
334
- "name": "Total",
335
- "type": "int",
336
- "value_allowed_null": false
337
- },
338
- {
339
- "disabled": false,
340
- "document": "客户的实例运行数",
341
- "example": "480",
342
- "member": "uint64",
343
- "name": "Running",
344
- "type": "int",
345
- "value_allowed_null": false
346
- },
347
2473
  {
348
2474
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
349
2475
  "member": "string",
@@ -353,33 +2479,34 @@
353
2479
  ],
354
2480
  "type": "object"
355
2481
  },
356
- "SaveGameArchiveRequest": {
357
- "document": "SaveGameArchive请求参数结构体",
2482
+ "StartAndroidInstancesRequest": {
2483
+ "document": "StartAndroidInstances请求参数结构体",
358
2484
  "members": [
359
2485
  {
360
2486
  "disabled": false,
361
- "document": "游戏用户ID",
362
- "example": "1621578692",
363
- "member": "string",
364
- "name": "UserId",
365
- "required": true,
366
- "type": "string"
367
- },
368
- {
369
- "disabled": false,
370
- "document": "游戏ID",
371
- "example": "game-a7l8c3ab",
2487
+ "document": "实例ID",
2488
+ "example": "",
372
2489
  "member": "string",
373
- "name": "GameId",
2490
+ "name": "AndroidInstanceIds",
374
2491
  "required": true,
375
- "type": "string"
2492
+ "type": "list"
376
2493
  }
377
2494
  ],
378
2495
  "type": "object"
379
2496
  },
380
- "SaveGameArchiveResponse": {
381
- "document": "SaveGameArchive返回参数结构体",
2497
+ "StartAndroidInstancesResponse": {
2498
+ "document": "StartAndroidInstances返回参数结构体",
382
2499
  "members": [
2500
+ {
2501
+ "disabled": false,
2502
+ "document": "任务集合\n注意:此字段可能返回 null,表示取不到有效值。",
2503
+ "example": "无",
2504
+ "member": "AndroidInstanceTask",
2505
+ "name": "TaskSet",
2506
+ "output_required": true,
2507
+ "type": "list",
2508
+ "value_allowed_null": true
2509
+ },
383
2510
  {
384
2511
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
385
2512
  "member": "string",
@@ -461,6 +2588,79 @@
461
2588
  ],
462
2589
  "type": "object"
463
2590
  },
2591
+ "StopAndroidInstancesAppRequest": {
2592
+ "document": "StopAndroidInstancesApp请求参数结构体",
2593
+ "members": [
2594
+ {
2595
+ "disabled": false,
2596
+ "document": "实例 ID 列表",
2597
+ "example": "[ \"cai-abcd1234\" ]",
2598
+ "member": "string",
2599
+ "name": "AndroidInstanceIds",
2600
+ "required": true,
2601
+ "type": "list"
2602
+ },
2603
+ {
2604
+ "disabled": false,
2605
+ "document": "应用包名",
2606
+ "example": "com.example.app",
2607
+ "member": "string",
2608
+ "name": "PackageName",
2609
+ "required": true,
2610
+ "type": "string"
2611
+ }
2612
+ ],
2613
+ "type": "object"
2614
+ },
2615
+ "StopAndroidInstancesAppResponse": {
2616
+ "document": "StopAndroidInstancesApp返回参数结构体",
2617
+ "members": [
2618
+ {
2619
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2620
+ "member": "string",
2621
+ "name": "RequestId",
2622
+ "type": "string"
2623
+ }
2624
+ ],
2625
+ "type": "object"
2626
+ },
2627
+ "StopAndroidInstancesRequest": {
2628
+ "document": "StopAndroidInstances请求参数结构体",
2629
+ "members": [
2630
+ {
2631
+ "disabled": false,
2632
+ "document": "实例ID",
2633
+ "example": "无",
2634
+ "member": "string",
2635
+ "name": "AndroidInstanceIds",
2636
+ "required": true,
2637
+ "type": "list"
2638
+ }
2639
+ ],
2640
+ "type": "object"
2641
+ },
2642
+ "StopAndroidInstancesResponse": {
2643
+ "document": "StopAndroidInstances返回参数结构体",
2644
+ "members": [
2645
+ {
2646
+ "disabled": false,
2647
+ "document": "任务集合\n注意:此字段可能返回 null,表示取不到有效值。",
2648
+ "example": "无",
2649
+ "member": "AndroidInstanceTask",
2650
+ "name": "TaskSet",
2651
+ "output_required": true,
2652
+ "type": "list",
2653
+ "value_allowed_null": true
2654
+ },
2655
+ {
2656
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2657
+ "member": "string",
2658
+ "name": "RequestId",
2659
+ "type": "string"
2660
+ }
2661
+ ],
2662
+ "type": "object"
2663
+ },
464
2664
  "StopGameRequest": {
465
2665
  "document": "StopGame请求参数结构体",
466
2666
  "members": [
@@ -578,6 +2778,160 @@
578
2778
  ],
579
2779
  "type": "object"
580
2780
  },
2781
+ "SyncAndroidInstanceImage": {
2782
+ "document": "同步安卓实例镜像信息",
2783
+ "members": [
2784
+ {
2785
+ "disabled": false,
2786
+ "document": "镜像 ID",
2787
+ "example": "image-abcd1234",
2788
+ "member": "string",
2789
+ "name": "AndroidInstanceImageId",
2790
+ "output_required": true,
2791
+ "type": "string",
2792
+ "value_allowed_null": false
2793
+ },
2794
+ {
2795
+ "disabled": false,
2796
+ "document": "镜像可用区",
2797
+ "example": "ap-guangzhou-3",
2798
+ "member": "string",
2799
+ "name": "AndroidInstanceImageZone",
2800
+ "output_required": true,
2801
+ "type": "string",
2802
+ "value_allowed_null": false
2803
+ }
2804
+ ],
2805
+ "usage": "out"
2806
+ },
2807
+ "SyncAndroidInstanceImageRequest": {
2808
+ "document": "SyncAndroidInstanceImage请求参数结构体",
2809
+ "members": [
2810
+ {
2811
+ "disabled": false,
2812
+ "document": "安卓实例镜像 ID",
2813
+ "example": "image-abcd1234",
2814
+ "member": "string",
2815
+ "name": "AndroidInstanceImageId",
2816
+ "required": true,
2817
+ "type": "string"
2818
+ },
2819
+ {
2820
+ "disabled": false,
2821
+ "document": "目的同步可用区列表",
2822
+ "example": "[\"ap-guangzhou-3\"]",
2823
+ "member": "string",
2824
+ "name": "DestinationZones",
2825
+ "required": true,
2826
+ "type": "list"
2827
+ }
2828
+ ],
2829
+ "type": "object"
2830
+ },
2831
+ "SyncAndroidInstanceImageResponse": {
2832
+ "document": "SyncAndroidInstanceImage返回参数结构体",
2833
+ "members": [
2834
+ {
2835
+ "disabled": false,
2836
+ "document": "同步安卓实例镜像列表",
2837
+ "example": "无",
2838
+ "member": "SyncAndroidInstanceImage",
2839
+ "name": "SyncAndroidInstanceImages",
2840
+ "output_required": true,
2841
+ "type": "list",
2842
+ "value_allowed_null": false
2843
+ },
2844
+ {
2845
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2846
+ "member": "string",
2847
+ "name": "RequestId",
2848
+ "type": "string"
2849
+ }
2850
+ ],
2851
+ "type": "object"
2852
+ },
2853
+ "SyncExecuteCommandOnAndroidInstancesRequest": {
2854
+ "document": "SyncExecuteCommandOnAndroidInstances请求参数结构体",
2855
+ "members": [
2856
+ {
2857
+ "disabled": false,
2858
+ "document": "安卓实例 ID 列表",
2859
+ "example": "[\"android_instance_id\"]",
2860
+ "member": "string",
2861
+ "name": "AndroidInstanceIds",
2862
+ "required": true,
2863
+ "type": "list"
2864
+ },
2865
+ {
2866
+ "disabled": false,
2867
+ "document": "shell 命令,必须是1秒内能自动结束的命令",
2868
+ "example": "ls -al; cat /etc/profile",
2869
+ "member": "string",
2870
+ "name": "Command",
2871
+ "required": true,
2872
+ "type": "string"
2873
+ }
2874
+ ],
2875
+ "type": "object"
2876
+ },
2877
+ "SyncExecuteCommandOnAndroidInstancesResponse": {
2878
+ "document": "SyncExecuteCommandOnAndroidInstances返回参数结构体",
2879
+ "members": [
2880
+ {
2881
+ "disabled": false,
2882
+ "document": "命令执行结果列表",
2883
+ "example": "无",
2884
+ "member": "SyncExecuteCommandResult",
2885
+ "name": "CommandResults",
2886
+ "output_required": true,
2887
+ "type": "list",
2888
+ "value_allowed_null": false
2889
+ },
2890
+ {
2891
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2892
+ "member": "string",
2893
+ "name": "RequestId",
2894
+ "type": "string"
2895
+ }
2896
+ ],
2897
+ "type": "object"
2898
+ },
2899
+ "SyncExecuteCommandResult": {
2900
+ "document": "同步执行命令结果",
2901
+ "members": [
2902
+ {
2903
+ "disabled": false,
2904
+ "document": "实例ID",
2905
+ "example": "cai-123",
2906
+ "member": "string",
2907
+ "name": "InstanceId",
2908
+ "output_required": true,
2909
+ "type": "string",
2910
+ "value_allowed_null": false
2911
+ },
2912
+ {
2913
+ "disabled": false,
2914
+ "document": "命令执行输出内容\n注意:此字段可能返回 null,表示取不到有效值。",
2915
+ "example": "无",
2916
+ "member": "string",
2917
+ "name": "Output",
2918
+ "output_required": true,
2919
+ "type": "string",
2920
+ "value_allowed_null": true
2921
+ },
2922
+ {
2923
+ "disabled": false,
2924
+ "document": "命令执行结果",
2925
+ "example": "SUCCESS|FAIL",
2926
+ "member": "string",
2927
+ "name": "Status",
2928
+ "output_required": true,
2929
+ "type": "string",
2930
+ "value_allowed_null": false
2931
+ }
2932
+ ],
2933
+ "usage": "out"
2934
+ },
581
2935
  "TrylockWorkerRequest": {
582
2936
  "document": "TrylockWorker请求参数结构体",
583
2937
  "members": [
@@ -649,6 +3003,107 @@
649
3003
  }
650
3004
  ],
651
3005
  "type": "object"
3006
+ },
3007
+ "UninstallAndroidInstancesAppRequest": {
3008
+ "document": "UninstallAndroidInstancesApp请求参数结构体",
3009
+ "members": [
3010
+ {
3011
+ "disabled": false,
3012
+ "document": "实例ID",
3013
+ "example": "cai-abcd1234",
3014
+ "member": "string",
3015
+ "name": "AndroidInstanceIds",
3016
+ "required": true,
3017
+ "type": "list"
3018
+ },
3019
+ {
3020
+ "disabled": false,
3021
+ "document": "应用ID",
3022
+ "example": "app-testabcd",
3023
+ "member": "string",
3024
+ "name": "AndroidAppId",
3025
+ "required": false,
3026
+ "type": "string"
3027
+ },
3028
+ {
3029
+ "disabled": false,
3030
+ "document": "包名",
3031
+ "example": "com.tencent.abc",
3032
+ "member": "string",
3033
+ "name": "PackageName",
3034
+ "required": false,
3035
+ "type": "string"
3036
+ }
3037
+ ],
3038
+ "type": "object"
3039
+ },
3040
+ "UninstallAndroidInstancesAppResponse": {
3041
+ "document": "UninstallAndroidInstancesApp返回参数结构体",
3042
+ "members": [
3043
+ {
3044
+ "disabled": false,
3045
+ "document": "任务集合\n注意:此字段可能返回 null,表示取不到有效值。",
3046
+ "example": "无",
3047
+ "member": "AndroidInstanceTask",
3048
+ "name": "TaskSet",
3049
+ "output_required": false,
3050
+ "type": "list",
3051
+ "value_allowed_null": true
3052
+ },
3053
+ {
3054
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3055
+ "member": "string",
3056
+ "name": "RequestId",
3057
+ "type": "string"
3058
+ }
3059
+ ],
3060
+ "type": "object"
3061
+ },
3062
+ "UploadFileToAndroidInstancesRequest": {
3063
+ "document": "UploadFileToAndroidInstances请求参数结构体",
3064
+ "members": [
3065
+ {
3066
+ "disabled": false,
3067
+ "document": "安卓实例 ID 列表",
3068
+ "example": "[\"cai_xxx\"]",
3069
+ "member": "string",
3070
+ "name": "AndroidInstanceIds",
3071
+ "required": true,
3072
+ "type": "list"
3073
+ },
3074
+ {
3075
+ "disabled": false,
3076
+ "document": "文件下载 URL",
3077
+ "example": "https://xxx",
3078
+ "member": "string",
3079
+ "name": "FileURL",
3080
+ "required": true,
3081
+ "type": "string"
3082
+ }
3083
+ ],
3084
+ "type": "object"
3085
+ },
3086
+ "UploadFileToAndroidInstancesResponse": {
3087
+ "document": "UploadFileToAndroidInstances返回参数结构体",
3088
+ "members": [
3089
+ {
3090
+ "disabled": false,
3091
+ "document": "实例任务集合",
3092
+ "example": "无",
3093
+ "member": "AndroidInstanceTask",
3094
+ "name": "TaskSet",
3095
+ "output_required": true,
3096
+ "type": "list",
3097
+ "value_allowed_null": false
3098
+ },
3099
+ {
3100
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3101
+ "member": "string",
3102
+ "name": "RequestId",
3103
+ "type": "string"
3104
+ }
3105
+ ],
3106
+ "type": "object"
652
3107
  }
653
3108
  },
654
3109
  "version": "1.0"