{ "name": "gs", "display_name": "云游戏", "description": "## 概述 腾讯云云游戏依托腾讯丰富的边缘计算节点、灵活的 GPU 虚拟化技术、稳定低延时的音视频互动能力，为游戏开发者提供一站式的云游戏 PaaS 解决方案。云游戏的游戏逻辑和渲染运算都在云端完成，并将渲染后的结果编码为音视频流通过网络传输给终端，终端则将用户的操作信息传输给云端和游戏进行实时交互。 开发者无需适配不同的软硬件平台，即可快速部署上线，\ufffd...", "domain": "other", "api_version": "2019-11-18", "endpoint": "gs.tencentcloudapi.com", "actions": [ { "name": "BackUpAndroidInstance", "description": "备份安卓实例。该接口需要联系我们开通内网存储才能使用。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例ID", "example": "cai-1a2b3c4d" }, { "name": "Includes", "type": "array", "required": false, "description": "包含的路径，支持仅含一个通配符*，通配符不能出现在路径开始", "example": "[ \"/data/tmp/\"]", "item_type": "string" }, { "name": "Excludes", "type": "array", "required": false, "description": "需要排除路径，支持仅含一个通配符*，通配符不能出现在路径开始", "example": "[ \"/data/tmp/\"]", "item_type": "string" } ], "required": [ "AndroidInstanceId" ] }, { "name": "BackUpAndroidInstanceToStorage", "description": "备份云手机数据到指定存储，支持 COS 和兼容 AWS S3 协议的对象存储服务。如果是备份到 COS 时，会使用公网流量，授权 COS bucket 请在控制台中操作。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例ID", "example": "cai-abcd1234" }, { "name": "StorageType", "type": "string", "required": true, "description": "存储服务器类型，如 COS、S3。注意：使用 COS 和 S3 都将占用外网带宽。", "example": "COS" }, { "name": "ObjectKey", "type": "string", "required": true, "description": "自定义对象Key", "example": "dir/file" }, { "name": "Includes", "type": "array", "required": false, "description": "包含的路径，支持仅含一个通配符*，通配符不能出现在路径开始", "example": "[\"/data/data/misc/*.prop\"]", "item_type": "string" }, { "name": "Excludes", "type": "array", "required": false, "description": "需要排除路径，支持仅含一个通配符*，通配符不能出现在路径开始", "example": "[\"/data/media/*\"]", "item_type": "string" }, { "name": "COSOptions", "type": "object", "required": false, "description": "COS协议选项", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "存储桶", "example": "bucket-123" }, { "name": "Region", "type": "string", "required": true, "description": "存储区域", "example": "ap-guangzhou" } ] }, { "name": "S3Options", "type": "object", "required": false, "description": "S3存储协议选项", "example": "无", "children": [ { "name": "EndPoint", "type": "string", "required": true, "description": "存储节点", "example": "https//123.com" }, { "name": "Bucket", "type": "string", "required": true, "description": "存储桶", "example": "bucket" }, { "name": "AccessKeyId", "type": "string", "required": true, "description": "密钥 ID", "example": "test-ak" }, { "name": "SecretAccessKey", "type": "string", "required": true, "description": "密钥 Key", "example": "test-sk" } ] } ], "required": [ "AndroidInstanceId", "StorageType", "ObjectKey" ] }, { "name": "CleanAndroidInstancesAppData", "description": "批量清理安卓实例应用数据", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表（最大100条数据）", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "PackageName", "type": "string", "required": true, "description": "应用包名", "example": "com.tencent.abc" } ], "required": [ "AndroidInstanceIds", "PackageName" ] }, { "name": "ConnectAndroidInstance", "description": "连接安卓实例", "status": "online", "parameters": [ { "name": "ClientSession", "type": "string", "required": true, "description": "用户Session信息", "example": "e30=" }, { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cai-abcd1234" }, { "name": "UserIp", "type": "string", "required": true, "description": "用户IP，用户客户端的公网IP，用于选择最佳网络链路", "example": "125.127.178.228" } ], "required": [ "ClientSession", "AndroidInstanceId", "UserIp" ] }, { "name": "CopyAndroidInstance", "description": "复制安卓实例： 1. 排除和包含文件只能指定 /data 下的文件，不指定时复制整个 /data 目录 2. 源实例和目的实例必须在同一区域 3. 复制时，源实例和目的实例都会停机，复制完后实例会自动启动 4. 复制时会产生大量内网流量，请限制并发", "status": "online", "parameters": [ { "name": "SourceAndroidInstanceId", "type": "string", "required": true, "description": "源安卓实例 ID", "example": "cai-1234abcd" }, { "name": "TargetAndroidInstanceId", "type": "string", "required": true, "description": "目的安卓实例 ID", "example": "cai-abcd1234" }, { "name": "Includes", "type": "array", "required": false, "description": "包含的路径，支持仅含一个通配符*，通配符不能出现在路径开始", "example": "[\"/data/data/misc/*.prop\"]", "item_type": "string" }, { "name": "Excludes", "type": "array", "required": false, "description": "需要排除路径，支持仅含一个通配符*，通配符不能出现在路径开始", "example": "[\"/data/media/*\"]", "item_type": "string" } ], "required": [ "SourceAndroidInstanceId", "TargetAndroidInstanceId" ] }, { "name": "CreateAndroidApp", "description": "创建安卓应用", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "安卓应用名字", "example": "测试App" }, { "name": "UserId", "type": "string", "required": false, "description": "用户 Id", "example": "user1" }, { "name": "AppMode", "type": "string", "required": false, "description": "应用模式（NORMAL : 普通模式、只支持 apk 文件上传，为默认值；ADVANCED : 高级模式、只支持上传 tgz 文件 和 自定义 shell 命令执行）", "example": "NORMAL" } ], "required": [ "Name" ] }, { "name": "CreateAndroidAppVersion", "description": "创建安卓应用版本", "status": "online", "parameters": [ { "name": "AndroidAppId", "type": "string", "required": true, "description": "应用ID", "example": "apk-xxxxx" }, { "name": "DownloadUrl", "type": "string", "required": false, "description": "应用包下载地址", "example": "https://xxxxx" }, { "name": "Command", "type": "string", "required": false, "description": "应用 shell 安装命令（支持多条命令执行，通过 \u0026\u0026 组合；只在应用 AppMode 为 ADVANCED 高级模式下 才会生效）", "example": "tar -zxvf test-1.0.X.tgz \u0026\u0026 cd test-1.0.X \u0026\u0026 ./install.sh" }, { "name": "UninstallCommand", "type": "string", "required": false, "description": "应用 shell 卸载命令（支持多条命令执行，通过 \u0026\u0026 组合；只在应用 AppMode 为 ADVANCED 高级模式下 才会生效）", "example": "cd test-1.0.X \u0026\u0026 ./uninstall.sh" }, { "name": "CleanupMode", "type": "string", "required": false, "description": "应用资源清理模式（实例安装应用所用资源），取值：CLEANUP_ON_UNINSTALL（默认值），卸载 App 时清理；CLEANUP_AFTER_INSTALL，安装 App 后立即清理。普通应用只有 CLEANUP_AFTER_INSTALL 模式。", "example": "CLEANUP_ON_UNINSTALL" } ], "required": [ "AndroidAppId" ] }, { "name": "CreateAndroidInstanceADB", "description": "创建云手机实例 ADB 连接信息，请将返回结果的 PrivateKey 字段保存为 pem 文件，并将 pem 文件权限设置为 600，再参考返回结果的 ConnectCommand 使用 adb 连接实例。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例 ID", "example": "cai-ab123456" } ], "required": [ "AndroidInstanceId" ] }, { "name": "CreateAndroidInstanceAcceleratorToken", "description": "创建安卓实例加速Token", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求的实例的上限为 500。", "example": "[ \"cai-a1b2c3d4\" ]", "item_type": "string" }, { "name": "UserIP", "type": "string", "required": false, "description": "用户IP，可以根据该 IP 选择就近加速点。如果不填，将自动选择就近加速点。", "example": "125.127.178.228" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "CreateAndroidInstanceImage", "description": "使用指定的安卓实例创建镜像，创建镜像时指定的实例会关机，镜像创建完成后实例会自动开机。当镜像的 AndroidInstanceImageState 为 NORMAL 时，镜像创建完成处于可用状态。", "status": "online", "parameters": [ { "name": "AndroidInstanceImageName", "type": "string", "required": true, "description": "安卓实例镜像名称", "example": "image-abc" }, { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例 ID", "example": "cai-abcd1234" }, { "name": "AndroidInstanceImageDescription", "type": "string", "required": false, "description": "安卓实例镜像描述", "example": "test-image" } ], "required": [ "AndroidInstanceImageName", "AndroidInstanceId" ] }, { "name": "CreateAndroidInstanceLabel", "description": "创建安卓实例标签", "status": "online", "parameters": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "key1" }, { "name": "Value", "type": "string", "required": false, "description": "标签值。普通场景下，该值不需要填写；高级场景下，需要两个层级进行分组时才填写。", "example": "value1" }, { "name": "Description", "type": "string", "required": false, "description": "标签描述", "example": "desc_test" } ], "required": [ "Key" ] }, { "name": "CreateAndroidInstanceSSH", "description": "创建安卓实例 SSH 连接信息，请将返回结果的 PrivateKey 字段保存为 pem 文件，并将 pem 文件权限设置为 600，再参考返回结果的 ConnectCommand 使用 ssh 连接实例。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cai-123456-abc" }, { "name": "ExpiredTime", "type": "string", "required": true, "description": "连接过期时间，最长可设置7天", "example": "2021-05-04T11:00:00Z" } ], "required": [ "AndroidInstanceId", "ExpiredTime" ] }, { "name": "CreateAndroidInstanceWebShell", "description": "创建安卓实例 WebShell 连接信息，返回的 ConnectUrl 可通过浏览器直接打开访问，链接有效期 1 小时，链接打开后可持续使用。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "实例 ID", "example": "cai-123456" } ], "required": [ "AndroidInstanceId" ] }, { "name": "CreateAndroidInstances", "description": "创建安卓实例", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "安卓实例可用区。 ap-guangzhou-3：广州三区 ap-shenzhen-1：深圳一区 ap-xian-ec-1：西安一区 ap-hangzhou-ec-1：杭州一区", "example": "ap-shenzhen-1" }, { "name": "Type", "type": "string", "required": true, "description": "安卓实例类型。 A1：单开 A2：双开 A3：三开 A4：四开 A5：五开 A6：六开", "example": "A3" }, { "name": "Number", "type": "integer", "required": true, "description": "当 HostSerialNumbers 不为空时，该参数表示每个宿主机要创建的安卓实例数量； 当 HostSerialNumbers 为空时，该参数表示要创建安卓实例的总数量，最大值为 100。", "example": "1" }, { "name": "HostSerialNumbers", "type": "array", "required": false, "description": "宿主机 ID 列表。可以指定宿主机 ID 进行创建；也可以不指定由系统自动分配宿主机。", "example": "[\"RK123\"]", "item_type": "string" }, { "name": "ImageId", "type": "string", "required": false, "description": "镜像 ID。如果不填，将使用默认的系统镜像", "example": "image-abc" }, { "name": "Labels", "type": "array", "required": false, "description": "安卓实例标签列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "key1" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "value1" } ] }, { "name": "Model", "type": "string", "required": false, "description": "安卓实例型号。YS1：默认值，基础型云手机GC0、GC1、GC2：三种性能型云手机", "example": "YS1" } ], "required": [ "Zone", "Type", "Number" ] }, { "name": "CreateAndroidInstancesAccessToken", "description": "创建安卓实例访问Token", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例 ID 列表。每次请求的实例的上限为 500。", "example": "[ \"cai-a1b2c3d4\" ]", "item_type": "string" }, { "name": "ExpirationDuration", "type": "string", "required": false, "description": "有效期，默认为 12 小时，最大为 24 小时。支持 s（秒）、m（分）、h（小时）等单位，比如 12h 表示 12 小时，1h2m3s 表示一小时两分三秒", "example": "12h" }, { "name": "Mode", "type": "string", "required": false, "description": "模式。 STANDARD：默认值，标准模式 ACCELERATED：加速模式，该模式需要开通加速服务才能生效", "example": "STANDARD" }, { "name": "UserIP", "type": "string", "required": false, "description": "用户 IP。在加速模式下，该字段必填。", "example": "125.127.178.228" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "CreateAndroidInstancesScreenshot", "description": "安卓实例截图", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例 ID 列表", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "CreateCosCredential", "description": "用于创建 Cos 临时密钥", "status": "online", "parameters": [ { "name": "CosType", "type": "string", "required": true, "description": "Cos 密钥类型，取值： Mobile 云手游、PC 云端游、AndroidApp 云手机应用管理、AndroidAppFile 云手机文件管理、AndroidAppBackup 云手机备份还原", "example": "AndroidApp" }, { "name": "AndroidAppCosInfo", "type": "object", "required": false, "description": "云手机应用管理 Cos 数据", "example": "{\"AndroidAppId\": \"apk-a1b2c3\",\"FileName\": \"test.apk\"}", "children": [ { "name": "AndroidAppId", "type": "string", "required": true, "description": "安卓应用ID", "example": "apk-xxxxx" }, { "name": "FileName", "type": "string", "required": false, "description": "应用名称（支持 apk 和 tgz 两种格式文件，当应用 AppMode 为 NORMAL 时，只支持上传 apk 类型文件，当应用 AppMode 为 ADVANCED 高级模式时，只支持上传 tgz 类型文件）", "example": "test.tgz" } ] }, { "name": "AndroidAppFileCosInfo", "type": "object", "required": false, "description": "云手机文件管理 Cos 数据", "example": "{\"FileId\": \"file-a1b2c3\"}", "children": [ { "name": "FileId", "type": "string", "required": true, "description": "文件 Id", "example": "file-a1b2c3" } ] } ], "required": [ "CosType" ] }, { "name": "CreateSession", "description": "创建会话", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）", "example": "xyz789" }, { "name": "GameId", "type": "string", "required": true, "description": "【已废弃】只在TrylockWorker时生效", "example": "game-abcd1234" }, { "name": "GameRegion", "type": "string", "required": false, "description": "【已废弃】只在TrylockWorker时生效", "example": "ap-guangzhou" }, { "name": "GameParas", "type": "string", "required": false, "description": "游戏参数", "example": "StartFor=1" }, { "name": "ClientSession", "type": "string", "required": false, "description": "客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空", "example": "e30=" }, { "name": "Resolution", "type": "string", "required": false, "description": "分辨率,，可设置为1080p或720p或1920x1080格式", "example": "1080p" }, { "name": "ImageUrl", "type": "string", "required": false, "description": "背景图url，格式为png或jpeg，宽高1920*1080", "example": "http://ip:port/test.png" }, { "name": "SetNo", "type": "integer", "required": false, "description": "【已废弃】", "example": "1" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "【已废弃】", "example": "2" }, { "name": "MaxBitrate", "type": "integer", "required": false, "description": "单位Mbps，动态调整最大码率建议值，会按实际情况调整", "example": "4" }, { "name": "MinBitrate", "type": "integer", "required": false, "description": "单位Mbps，动态调整最小码率建议值，会按实际情况调整", "example": "2" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，可设置为30、45、60、90、120、144", "example": "60" }, { "name": "UserIp", "type": "string", "required": false, "description": "【推荐填写】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验", "example": "125.127.178.228" }, { "name": "Optimization", "type": "integer", "required": false, "description": "【已废弃】优化项，便于客户灰度开启新的优化项，默认为0", "example": "0" }, { "name": "HostUserId", "type": "string", "required": false, "description": "【互动云游】游戏主机用户ID", "example": "abc123" }, { "name": "Role", "type": "string", "required": false, "description": "【互动云游】角色；Player表示玩家；Viewer表示观察者", "example": "Player" }, { "name": "GameContext", "type": "string", "required": false, "description": "游戏相关参数", "example": "{\"Key\": \"Value\"}" }, { "name": "RunMode", "type": "string", "required": false, "description": "云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。", "example": "RunWithoutClient" } ], "required": [ "UserId", "GameId" ] }, { "name": "DeleteAndroidApp", "description": "删除安卓应用", "status": "online", "parameters": [ { "name": "AndroidAppId", "type": "string", "required": true, "description": "应用ID", "example": "apk-xxxx" } ], "required": [ "AndroidAppId" ] }, { "name": "DeleteAndroidAppVersion", "description": "删除安卓应用版本", "status": "online", "parameters": [ { "name": "AndroidAppId", "type": "string", "required": true, "description": "安卓应用 Id", "example": "\"apk-a1b2c3\"" }, { "name": "AndroidAppVersion", "type": "string", "required": true, "description": "安卓应用版本", "example": "\"ver-a1b2c3\"" } ], "required": [ "AndroidAppId", "AndroidAppVersion" ] }, { "name": "DeleteAndroidInstanceBackupFiles", "description": "删除安卓实例备份文件", "status": "online", "parameters": [ { "name": "ObjectKeys", "type": "array", "required": true, "description": "文件对象键列表", "example": "[ \"/dir/test_file\" ]", "item_type": "string" }, { "name": "StorageType", "type": "string", "required": true, "description": "存储服务器类型，如 COS、S3。注意：使用 COS 和 S3 都将占用外网带宽。", "example": "S3" }, { "name": "COSOptions", "type": "object", "required": false, "description": "COS协议选项", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "存储桶", "example": "bucket-123" }, { "name": "Region", "type": "string", "required": true, "description": "存储区域", "example": "ap-guangzhou" } ] }, { "name": "S3Options", "type": "object", "required": false, "description": "S3存储协议选项", "example": "无", "children": [ { "name": "EndPoint", "type": "string", "required": true, "description": "存储节点", "example": "https//123.com" }, { "name": "Bucket", "type": "string", "required": true, "description": "存储桶", "example": "bucket" }, { "name": "AccessKeyId", "type": "string", "required": true, "description": "密钥 ID", "example": "test-ak" }, { "name": "SecretAccessKey", "type": "string", "required": true, "description": "密钥 Key", "example": "test-sk" } ] }, { "name": "AndroidInstanceZone", "type": "string", "required": false, "description": "安卓实例可用区。StorageType 为 S3 时，需要填写该字段；StorageType 为 COS 时，不需要填写该字段", "example": "ap-beijing-1" } ], "required": [ "ObjectKeys", "StorageType" ] }, { "name": "DeleteAndroidInstanceBackups", "description": "批量删除安卓实例备份", "status": "online", "parameters": [ { "name": "BackupIds", "type": "array", "required": true, "description": "备份ID列表", "example": "[\"backup-1a2b\"]", "item_type": "string" } ], "required": [ "BackupIds" ] }, { "name": "DeleteAndroidInstanceImages", "description": "删除安卓实例镜像", "status": "online", "parameters": [ { "name": "AndroidInstanceImageIds", "type": "array", "required": true, "description": "镜像 ID 列表", "example": "image-abc", "item_type": "string" } ], "required": [ "AndroidInstanceImageIds" ] }, { "name": "DeleteAndroidInstanceLabel", "description": "删除安卓实例标签", "status": "online", "parameters": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "key1" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "value1" } ], "required": [ "Key" ] }, { "name": "DescribeAndroidApps", "description": "查询安卓应用信息", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量", "example": "10" }, { "name": "AndroidAppIds", "type": "array", "required": false, "description": "应用ID数组", "example": "[\"xxx\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，支持过滤的字段有：UserId、State、UpdateState、Name、AppMode 。其中 Name 为模糊匹配，其他参数为精确匹配。", "example": "[{\"Name\":\"UserId\",\"Values\":[\"user1\"]}]\t", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名", "example": "key01" }, { "name": "Values", "type": "array", "required": true, "description": "字段值列表", "example": "[ \"value01\", \"value11\" ]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeAndroidInstanceApps", "description": "查询安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cai-abcd1234" } ], "required": [ "AndroidInstanceId" ] }, { "name": "DescribeAndroidInstanceBackups", "description": "查询安卓实例备份列表", "status": "online", "parameters": [ { "name": "BackupIds", "type": "array", "required": false, "description": "备份ID列表", "example": "[\"backup-1a2b\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页数量", "example": "100" } ], "required": [] }, { "name": "DescribeAndroidInstanceImages", "description": "查询安卓实例镜像信息，当镜像的 AndroidInstanceImageState 为 NORMAL 时，镜像处于可用状态。", "status": "online", "parameters": [ { "name": "AndroidInstanceImageIds", "type": "array", "required": false, "description": "镜像 ID 列表", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "AndroidInstanceImageZones", "type": "array", "required": false, "description": "镜像可用区列表", "example": "[\"ap-shenzhen-1\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量，默认为20，最大值为100", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "字段过滤器。Filter 的 Name 有以下值： ImageModel：镜像型号 ImageName：镜像名称 ImageState：镜像状态 AndroidVersion：安卓版本", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名", "example": "key01" }, { "name": "Values", "type": "array", "required": true, "description": "字段值列表", "example": "[ \"value01\", \"value11\" ]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeAndroidInstanceLabels", "description": "查询安卓实例标签", "status": "online", "parameters": [ { "name": "Keys", "type": "array", "required": false, "description": "标签键列表", "example": "[ \"key1\" ]", "item_type": "string" }, { "name": "Values", "type": "array", "required": false, "description": "标签值列表", "example": "[ \"value1\" ]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量，默认为20，最大值为100", "example": "50" } ], "required": [] }, { "name": "DescribeAndroidInstanceTasksStatus", "description": "查询安卓实例任务状态", "status": "online", "parameters": [ { "name": "TaskIds", "type": "array", "required": false, "description": "任务 ID 列表", "example": "[ \"615cf0a4-075e-4cf5-b26f-d786363daccd\" ]", "item_type": "string" }, { "name": "Filter", "type": "array", "required": false, "description": "条件过滤器", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名", "example": "key01" }, { "name": "Values", "type": "array", "required": true, "description": "字段值列表", "example": "[ \"value01\", \"value11\" ]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量，默认为20，最大值为100", "example": "10" }, { "name": "RecentDays", "type": "integer", "required": false, "description": "时间范围限制，以天数为单位", "example": "7" } ], "required": [] }, { "name": "DescribeAndroidInstances", "description": "查询安卓实例", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量，默认为20，最大值为100", "example": "50" }, { "name": "AndroidInstanceIds", "type": "array", "required": false, "description": "实例ID。每次请求的实例的上限为100。", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "AndroidInstanceRegion", "type": "string", "required": false, "description": "实例地域。目前还不支持按地域进行聚合查询", "example": "ap-beijing" }, { "name": "AndroidInstanceZone", "type": "string", "required": false, "description": "实例可用区", "example": "ap-beijing-1" }, { "name": "AndroidInstanceGroupIds", "type": "array", "required": false, "description": "实例分组 ID 列表", "example": "[ \"aig-1234abcd' ]", "item_type": "string" }, { "name": "LabelSelector", "type": "array", "required": false, "description": "实例标签选择器", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "key1" }, { "name": "Operator", "type": "string", "required": true, "description": "运算符类型。 IN：要求对象的标签键 Key 对应的标签值需满足 Values 中的一个 NOT_IN：要求对象的标签键 Key 对应的标签值不满足 Values 中的任何一个 EXISTS：要求对象标签存在标签键 Key NOT_EXISTS: 要求对象标签不存在标签键 Key", "example": "IN" }, { "name": "Values", "type": "array", "required": false, "description": "标签值列表", "example": "[\"value1\"]", "item_type": "string" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "字段过滤器。Filter 的 Name 有以下值： Name：实例名称 UserId：实例用户ID HostSerialNumber：宿主机序列号 HostServerSerialNumber：机箱序列号 AndroidInstanceModel：实例型号", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名", "example": "key01" }, { "name": "Values", "type": "array", "required": true, "description": "字段值列表", "example": "[ \"value01\", \"value11\" ]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeAndroidInstancesAppBlacklist", "description": "查询安卓实例黑名单", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例 ID 列表，数量上限 100", "example": "[\"cai-xxx\"]", "item_type": "string" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "DescribeAndroidInstancesByApps", "description": "批量查询安装指定应用的安卓实例", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认为 0", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制量，默认为 20，最大值为 500", "example": "50" }, { "name": "AndroidAppIds", "type": "array", "required": true, "description": "应用 ID 列表。当 AndroidIds 为多条数据时（例如 app1, app2），返回的实例列表为：安装了 app1 应用的实例和安装了 app2 应用的实例集合（并集）。", "example": "[ \"apk-a1b2c3\" ]\t", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "字段过滤器，Filter 的 Name 有以下值： AndroidInstanceId：实例 Id", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名", "example": "key01" }, { "name": "Values", "type": "array", "required": true, "description": "字段值列表", "example": "[ \"value01\", \"value11\" ]", "item_type": "string" } ] } ], "required": [ "Offset", "Limit", "AndroidAppIds" ] }, { "name": "DescribeInstancesCount", "description": "获取并发总数和运行数", "status": "online", "parameters": [ { "name": "GameId", "type": "string", "required": false, "description": "游戏ID", "example": "game-abcd1234" }, { "name": "GroupId", "type": "string", "required": false, "description": "实例分组ID", "example": "cgg-1234abcd" }, { "name": "GameRegion", "type": "string", "required": false, "description": "游戏区域", "example": "ap-guangzhou" }, { "name": "GameType", "type": "string", "required": false, "description": "游戏类型。 MOBILE：手游 PC：默认值，端游", "example": "MOBILE" } ], "required": [] }, { "name": "DestroyAndroidInstances", "description": "销毁安卓实例", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"abc\", \"def\"]", "item_type": "string" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "DisableAndroidInstancesApp", "description": "批量禁用安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表（最大100条数据）", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "PackageName", "type": "string", "required": true, "description": "应用包名", "example": "com.tencent.abc" } ], "required": [ "AndroidInstanceIds", "PackageName" ] }, { "name": "DisconnectAndroidInstance", "description": "断开安卓实例", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cai-1a2b" } ], "required": [ "AndroidInstanceId" ] }, { "name": "DisconnectAndroidInstanceAccelerator", "description": "断开安卓实例加速节点", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "实例ID", "example": "cai-1a2b" }, { "name": "UserId", "type": "string", "required": false, "description": "用户 ID。用户 ID 为空，将断开该实例的所有用户连接；用户 ID 不为空，只断开该用户的连接。", "example": "user-001" } ], "required": [ "AndroidInstanceId" ] }, { "name": "DistributeAndroidInstanceImageToHosts", "description": "分发安卓实例镜像至宿主机", "status": "online", "parameters": [ { "name": "HostSerialNumbers", "type": "array", "required": true, "description": "宿主机序列号数组", "example": "[\"RK5838P1262201165\"]", "item_type": "string" }, { "name": "ImageId", "type": "string", "required": true, "description": "实例镜像 ID", "example": "image-a5drda9q" } ], "required": [ "HostSerialNumbers", "ImageId" ] }, { "name": "DistributeFileToAndroidInstances", "description": "将一个文件批量分发到多个实例，一次接口调用触发一次文件分发，一次文件分发只会从公网下载一次，然后文件会走内网分发到实例列表中的实例。", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"cai_xxx\"]", "item_type": "string" }, { "name": "FileURL", "type": "string", "required": true, "description": "文件下载 URL", "example": "https://xxx" }, { "name": "DestinationDirectory", "type": "string", "required": true, "description": "上传目标目录，只能上传到 /sdcard/ 目录或其子目录下", "example": "/sdcard/Download/" }, { "name": "DestinationFileName", "type": "string", "required": false, "description": "目标文件名", "example": "file_name" } ], "required": [ "AndroidInstanceIds", "FileURL", "DestinationDirectory" ] }, { "name": "DistributePhotoToAndroidInstances", "description": "将一张照片批量分发到多个实例的相册中，一次接口调用触发一次照片分发，一次照片分发只会从公网下载一次，然后照片会走内网分发到实例列表中的实例。", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"cai_xxx\"]", "item_type": "string" }, { "name": "PhotoURL", "type": "string", "required": true, "description": "照片下载 URL", "example": "https://xxx" } ], "required": [ "AndroidInstanceIds", "PhotoURL" ] }, { "name": "EnableAndroidInstancesApp", "description": "批量启用安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表（最大100条数据）", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "PackageName", "type": "string", "required": true, "description": "应用包名", "example": "com.tencent.abc" } ], "required": [ "AndroidInstanceIds", "PackageName" ] }, { "name": "ExecuteCommandOnAndroidInstances", "description": "在安卓实例上异步执行命令，命令输出结果如果内容过长会被截断", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "Command", "type": "string", "required": true, "description": "shell 命令", "example": "ls -al; cat /etc/profile" } ], "required": [ "AndroidInstanceIds", "Command" ] }, { "name": "FetchAndroidInstancesLogs", "description": "批量将实例的 logcat 日志文件上传到您已授权的 COS bucket 中，授权 COS bucket 请在控制台中操作。", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"cai_xxx\"]", "item_type": "string" }, { "name": "BucketName", "type": "string", "required": true, "description": "cos 桶名称", "example": "test-appid" }, { "name": "BucketRegion", "type": "string", "required": true, "description": "cos 桶区域", "example": "ap-guangzhou" }, { "name": "BucketDirectory", "type": "string", "required": false, "description": "cos 桶目录，默认为 /log/", "example": "/log/" }, { "name": "RecentDays", "type": "integer", "required": false, "description": "下载最近几天的日志，默认值为 1", "example": "1" } ], "required": [ "AndroidInstanceIds", "BucketName", "BucketRegion" ] }, { "name": "ImportAndroidInstanceImage", "description": "导入安卓实例镜像，当镜像的 AndroidInstanceImageState 为 NORMAL 时，镜像导入完成处于可用状态。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "镜像名称", "example": "image-abc" }, { "name": "URL", "type": "string", "required": true, "description": "镜像文件下载地址，要求是 tgz 压缩文件", "example": "https//image.test.com" }, { "name": "MD5", "type": "string", "required": true, "description": "镜像文件 MD5 值", "example": "539b8575d2a458cab56abb51f74601d6" }, { "name": "AndroidVersion", "type": "string", "required": false, "description": "安卓版本。 ANDROID10：默认值，安卓10 ANDROID12：安卓12 ANDROID14：安卓14", "example": "ANDROID10" }, { "name": "Zone", "type": "string", "required": false, "description": "镜像可用区", "example": "ap-shenzhen-1" } ], "required": [ "Name", "URL", "MD5" ] }, { "name": "InstallAndroidInstancesApp", "description": "安装安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "AndroidAppId", "type": "string", "required": true, "description": "应用ID", "example": "apk-drkmskme" }, { "name": "AndroidAppVersion", "type": "string", "required": false, "description": "应用版本", "example": "1719564791910084130" }, { "name": "InstallationMethod", "type": "string", "required": false, "description": "安装方式。 CLEAR_DATA 默认，清理数据 KEEP_DATA 保留数据", "example": "CLEAR_DATA" } ], "required": [ "AndroidInstanceIds", "AndroidAppId" ] }, { "name": "InstallAndroidInstancesAppWithURL", "description": "通过 URL 安装安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID", "example": "[\"cai-1300055477-ea99qwovyrq\"]", "item_type": "string" }, { "name": "AndroidAppURL", "type": "string", "required": true, "description": "安卓应用下载 URL", "example": "https://test.cos.ap-nanjing.myqcloud.com/tmp/177.apk" }, { "name": "AndroidAppMD5", "type": "string", "required": false, "description": "安卓应用MD5码值（32位小写十六进制字符串）", "example": "fa9af5f509423f9add5c5a7e472dde4d" } ], "required": [ "AndroidInstanceIds", "AndroidAppURL" ] }, { "name": "ModifyAndroidApp", "description": "修改安卓应用信息", "status": "online", "parameters": [ { "name": "AndroidAppId", "type": "string", "required": true, "description": "安卓应用 Id", "example": "\"apk-a1b2c3\"" }, { "name": "Name", "type": "string", "required": true, "description": "安卓应用名称", "example": "\"abc\"" }, { "name": "UserId", "type": "string", "required": false, "description": "用户 Id", "example": "\"user1\"" } ], "required": [ "AndroidAppId", "Name" ] }, { "name": "ModifyAndroidAppVersion", "description": "修改安卓应用版本", "status": "online", "parameters": [ { "name": "AndroidAppId", "type": "string", "required": true, "description": "安卓应用 Id", "example": "\"apk-a1b2c3\"" }, { "name": "AndroidAppVersion", "type": "string", "required": true, "description": "安卓应用版本 Id", "example": "\"ver-a1b2c3\"" }, { "name": "AndroidAppVersionName", "type": "string", "required": true, "description": "安卓应用版本名称", "example": "\"a1b2c3\"" }, { "name": "Command", "type": "string", "required": false, "description": "应用 shell 安装命令（支持多条命令执行，通过 \u0026\u0026 组合；只在应用 AppMode 为 ADVANCED 高级模式下 才会生效）", "example": "\"tar -zxvf test-1.0.X.tgz \u0026\u0026 cd test-1.0.X \u0026\u0026 ./install.sh\"" }, { "name": "UninstallCommand", "type": "string", "required": false, "description": "应用 shell 卸载命令（支持多条命令执行，通过 \u0026\u0026 组合；只在应用 AppMode 为 ADVANCED 高级模式下 才会生效）", "example": "\"cd test-1.0.X \u0026\u0026 ./uninstall.sh\"" } ], "required": [ "AndroidAppId", "AndroidAppVersion", "AndroidAppVersionName" ] }, { "name": "ModifyAndroidInstanceInformation", "description": "修改安卓实例的信息", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例 ID", "example": "cai-abcd1234" }, { "name": "Name", "type": "string", "required": false, "description": "实例名称", "example": "testname" } ], "required": [ "AndroidInstanceId" ] }, { "name": "ModifyAndroidInstanceResolution", "description": "修改安卓实例分辨率。需要注意的是该接口可能导致正在运行的应用出现闪退，所以建议在实例维护时期才进行调用。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例 ID", "example": "cai-abcd1234" }, { "name": "Width", "type": "integer", "required": true, "description": "分辨率宽度。建议按照以下数值设置，避免出现性能不足问题： 实例类型为单开（A1）：建议设置为 1080 实例类型为双开（A2） 及以上：建议设置为 720", "example": "720" }, { "name": "Height", "type": "integer", "required": true, "description": "分辨率高度。建议按照以下数值设置，避免出现性能不足问题： 实例类型为单开（A1）：建议设置为 1920 实例类型为双开（A2） 及以上：建议设置为 1280", "example": "1280" }, { "name": "DPI", "type": "integer", "required": false, "description": "每英寸像素点。如果不填，系统将会计算一个合理的数值。修改 DPI 可能会导致 App 异常退出，请谨慎使用！ 分辨率为 720x1280：建议配置为 320 分辨率为 1080x1920：建议配置为 480", "example": "320" }, { "name": "FPS", "type": "integer", "required": false, "description": "帧率。ResolutionType 为 PHYSICAL 时才会修改帧率。另外建议按照以下数值设置，避免出现性能不足问题： 实例类型为单开（A1）：建议设置为 60 实例类型为双开（A2） 及以上：建议设置为 30", "example": "30" }, { "name": "ResolutionType", "type": "string", "required": false, "description": "修改分辨率类型。修改物理分辨率，需要重启才能生效。 OVERRIDE：默认值，修改覆盖（显示）分辨率 PHYSICAL：修改物理分辨率", "example": "PHYSICAL" } ], "required": [ "AndroidInstanceId", "Width", "Height" ] }, { "name": "ModifyAndroidInstancesAppBlacklist", "description": "修改安卓实例应用黑名单", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID列表，数量上限100", "example": "[\"cai-xxad\"]", "item_type": "string" }, { "name": "AppList", "type": "array", "required": true, "description": "应用列表", "example": "[\"com.app\"]", "item_type": "string" }, { "name": "Operation", "type": "string", "required": true, "description": "ADD、REMOVE、CLEAR", "example": "ADD" } ], "required": [ "AndroidInstanceIds", "AppList", "Operation" ] }, { "name": "ModifyAndroidInstancesInformation", "description": "批量修改安卓实例信息", "status": "online", "parameters": [ { "name": "AndroidInstanceInformations", "type": "array", "required": true, "description": "安卓实例信息数据", "example": "无", "item_type": "object", "children": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例 ID", "example": "cai-abcd1234" }, { "name": "Name", "type": "string", "required": true, "description": "实例名称", "example": "test_name" } ] } ], "required": [ "AndroidInstanceInformations" ] }, { "name": "ModifyAndroidInstancesLabels", "description": "批量修改安卓实例的标签", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "Operation", "type": "string", "required": true, "description": "操作类型。ADD：标签键不存在的添加新标签，标签键存在的将覆盖原有标签REMOVE：根据标签键删除标签REPLACE：使用请求标签列表替换原来所有标签CLEAR：清除所有标签", "example": "ADD" }, { "name": "AndroidInstanceLabels", "type": "array", "required": false, "description": "安卓实例标签列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "key1" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "value1" } ] } ], "required": [ "AndroidInstanceIds", "Operation" ] }, { "name": "ModifyAndroidInstancesProperties", "description": "批量修改安卓实例属性", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "AndroidInstanceDevice", "type": "object", "required": false, "description": "安卓实例设备", "example": "无", "children": [ { "name": "Brand", "type": "string", "required": true, "description": "品牌", "example": "YourBrand" }, { "name": "Model", "type": "string", "required": true, "description": "型号", "example": "YourModel" } ] }, { "name": "AndroidInstanceProperties", "type": "array", "required": false, "description": "安卓实例其它属性列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "属性键", "example": "device.name" }, { "name": "Value", "type": "string", "required": false, "description": "属性值", "example": "TestName" } ] } ], "required": [ "AndroidInstanceIds" ] }, { "name": "ModifyAndroidInstancesResolution", "description": "修改安卓实例分辨率。需要注意的是该接口需要重启才能生效。", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "Width", "type": "integer", "required": true, "description": "分辨率宽度。建议按照以下数值设置，避免出现性能不足问题： 实例类型为单开（A1）：建议设置为 1080 实例类型为双开（A2） 及以上：建议设置为 720", "example": "720" }, { "name": "Height", "type": "integer", "required": true, "description": "分辨率高度。建议按照以下数值设置，避免出现性能不足问题： 实例类型为单开（A1）：建议设置为 1920 实例类型为双开（A2） 及以上：建议设置为 1280", "example": "1280" }, { "name": "DPI", "type": "integer", "required": true, "description": "每英寸像素点。 分辨率为 720x1280：建议配置为 320 分辨率为 1080x1920：建议配置为 480", "example": "320" }, { "name": "FPS", "type": "integer", "required": false, "description": "帧率。ResolutionType 为 PHYSICAL 时才会修改帧率。另外建议按照以下数值设置，避免出现性能不足问题： 实例类型为单开（A1）：建议设置为 60 实例类型为双开（A2） 及以上：建议设置为 30", "example": "30" }, { "name": "ResolutionType", "type": "string", "required": false, "description": "修改分辨率类型。修改物理分辨率，需要重启才能生效。 OVERRIDE：默认值，修改覆盖（显示）分辨率 PHYSICAL：修改物理分辨率", "example": "PHYSICAL" } ], "required": [ "AndroidInstanceIds", "Width", "Height", "DPI" ] }, { "name": "ModifyAndroidInstancesResources", "description": "批量修改安卓实例资源限制", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表（最大100条数据）", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "MemoryQuota", "type": "integer", "required": true, "description": "内存配额（单位 MB）", "example": "200" } ], "required": [ "AndroidInstanceIds", "MemoryQuota" ] }, { "name": "ModifyAndroidInstancesUserId", "description": "批量修改安卓实例的用户ID", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "UserId", "type": "string", "required": false, "description": "用户 ID", "example": "user123" }, { "name": "ExpirationDuration", "type": "string", "required": false, "description": "有效时长。如果不填该字段，默认为永久。支持 s（秒）、m（分）、h（小时）、d（天）等单位，比如 12h 表示 12 小时，1h2m3s 表示一小时两分三秒", "example": "12h" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "RebootAndroidInstanceHosts", "description": "重启安卓实例宿主机。请注意： - 当前每 15 分钟只能重启一次 - 一个宿主机可能有多个云手机实例，重启宿主机会影响运行在上面的所有实例，请确保该宿主机上的所有云手机实例未投入业务使用", "status": "online", "parameters": [ { "name": "HostSerialNumbers", "type": "array", "required": true, "description": "宿主机序列号集合", "example": "[\"RK5838P1262201165\"]", "item_type": "string" } ], "required": [ "HostSerialNumbers" ] }, { "name": "RebootAndroidInstances", "description": "重启安卓实例", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "RenewAndroidInstancesAccessToken", "description": "续期安卓实例访问Token", "status": "online", "parameters": [ { "name": "AccessToken", "type": "string", "required": true, "description": "token", "example": "TestToken" }, { "name": "ExpirationDuration", "type": "string", "required": false, "description": "有效期，默认为 12 小时，最大为 24 小时。支持 s（秒）、m（分）、h（小时）等单位，比如 12h 表示 12 小时，1h2m3s 表示一小时两分三秒", "example": "12h" } ], "required": [ "AccessToken" ] }, { "name": "ResetAndroidInstances", "description": "重置安卓实例", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID列表", "example": "[\"abc\"]", "item_type": "string" }, { "name": "AndroidInstanceImageId", "type": "string", "required": false, "description": "指定有效的镜像 ID。 默认取值：默认使用当前镜像。", "example": "image-abc" }, { "name": "Mode", "type": "string", "required": false, "description": "重置模式。在 AndroidInstanceImageId 不为空时才生效。 CleanData：默认选项，清理系统属性和用户数据 KeepSystemProperties：只保留系统属性 KeepData: 保留系统属性和用户数据", "example": "CleanData" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "RestartAndroidInstancesApp", "description": "重启安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例 ID 列表", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "PackageName", "type": "string", "required": true, "description": "应用包名", "example": "com.example.app" }, { "name": "Activity", "type": "string", "required": false, "description": "启动页。建议指定启动页来启动应用，避免启动失败。如果启动页为空，系统尝试根据 PackageName 启动，但不保证成功。", "example": ".MainActivity" } ], "required": [ "AndroidInstanceIds", "PackageName" ] }, { "name": "RestoreAndroidInstance", "description": "还原安卓实例。该接口需要联系我们开通内网存储才能使用。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例 ID", "example": "cai-1a2b3c4d" }, { "name": "BackupId", "type": "string", "required": true, "description": "备份 ID", "example": "backup-1a2b" } ], "required": [ "AndroidInstanceId", "BackupId" ] }, { "name": "RestoreAndroidInstanceFromStorage", "description": "使用指定存储数据还原云手机，支持 COS 和兼容 AWS S3 协议的对象存储服务。如果还原数据来自 COS 时，会使用公网流量，授权 COS bucket 请在控制台中操作。", "status": "online", "parameters": [ { "name": "AndroidInstanceId", "type": "string", "required": true, "description": "安卓实例ID", "example": "cai-abcd1234" }, { "name": "ObjectKey", "type": "string", "required": true, "description": "自定义备份对象Key", "example": "testkey" }, { "name": "StorageType", "type": "string", "required": true, "description": "存储服务器类型，如 COS、S3。注意：使用 COS 和 S3 都将占用外网带宽。", "example": "COS" }, { "name": "COSOptions", "type": "object", "required": false, "description": "COS协议选项", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "存储桶", "example": "bucket-123" }, { "name": "Region", "type": "string", "required": true, "description": "存储区域", "example": "ap-guangzhou" } ] }, { "name": "S3Options", "type": "object", "required": false, "description": "S3存储协议选项", "example": "无", "children": [ { "name": "EndPoint", "type": "string", "required": true, "description": "存储节点", "example": "https//123.com" }, { "name": "Bucket", "type": "string", "required": true, "description": "存储桶", "example": "bucket" }, { "name": "AccessKeyId", "type": "string", "required": true, "description": "密钥 ID", "example": "test-ak" }, { "name": "SecretAccessKey", "type": "string", "required": true, "description": "密钥 Key", "example": "test-sk" } ] } ], "required": [ "AndroidInstanceId", "ObjectKey", "StorageType" ] }, { "name": "SaveGameArchive", "description": "保存游戏存档", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "游戏用户ID", "example": "1621578692" }, { "name": "GameId", "type": "string", "required": true, "description": "游戏ID", "example": "game-a7l8c3ab" } ], "required": [ "UserId", "GameId" ] }, { "name": "SetAndroidInstancesBGAppKeepAlive", "description": "批量设置安卓实例应用后台保活，开启应用保活，只是降低应用被杀死或回收的优先级，并不能保证应用不会被杀死或回收（如出现内存不足等资源限制时，应用也有概率被杀死或回收）", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表（最大100条数据）", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "Operation", "type": "string", "required": true, "description": "操作类型，取值：ADD 添加应用到后台保活列表、REMOVE 从后台保活列表中移除应用、SET 全量设置后台保活列表，替换当前列表。", "example": "ADD" }, { "name": "PackageNames", "type": "array", "required": true, "description": "应用包名列表", "example": "[\"com.tencent.abc\"]", "item_type": "string" } ], "required": [ "AndroidInstanceIds", "Operation", "PackageNames" ] }, { "name": "SetAndroidInstancesFGAppKeepAlive", "description": "批量设置安卓实例应用前台保活，开启应用保活，只是降低应用被杀死或回收的优先级，并不能保证应用不会被杀死或回收（如出现内存不足等资源限制时，应用也有概率被杀死或回收）", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表（最大100条数据）", "example": "[\"cai-abcd1234\"]", "item_type": "string" }, { "name": "Operation", "type": "string", "required": true, "description": "操作类型，取值：ENABLE 开启保活、DISABLE 关闭保活。当关闭保活时，PackageName 参数传空即可", "example": "ENABLE" }, { "name": "PackageName", "type": "string", "required": false, "description": "应用包名，开启保活时，必须传入 PackageName", "example": "com.tencent.abc" } ], "required": [ "AndroidInstanceIds", "Operation" ] }, { "name": "StartAndroidInstances", "description": "开机安卓实例", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "StartAndroidInstancesApp", "description": "启动安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例 ID 列表", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "PackageName", "type": "string", "required": true, "description": "应用包名", "example": "com.example.app" }, { "name": "Activity", "type": "string", "required": false, "description": "启动页。建议指定启动页来启动应用，避免启动失败。如果启动页为空，系统尝试根据 PackageName 启动，但不保证成功。", "example": ".MainActivity" } ], "required": [ "AndroidInstanceIds", "PackageName" ] }, { "name": "StartPublishStream", "description": "开始云端推流", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）", "example": "639d069e-a13a-437a-a10b-64a33ecb8e79" }, { "name": "PublishUrl", "type": "string", "required": true, "description": "推流地址，仅支持rtmp协议", "example": "rtmp://live.stream.com/publish" } ], "required": [ "UserId", "PublishUrl" ] }, { "name": "StartPublishStreamToCSS", "description": "开始云端推流", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）", "example": "abc123" }, { "name": "PublishStreamArgs", "type": "string", "required": false, "description": "推流参数，推流时携带自定义参数。", "example": "bar=1\u0026foo=2" } ], "required": [ "UserId" ] }, { "name": "StopAndroidInstances", "description": "关机安卓实例", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "StopAndroidInstancesApp", "description": "停止安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例 ID 列表", "example": "[ \"cai-abcd1234\" ]", "item_type": "string" }, { "name": "PackageName", "type": "string", "required": true, "description": "应用包名", "example": "com.example.app" } ], "required": [ "AndroidInstanceIds", "PackageName" ] }, { "name": "StopGame", "description": "强制退出游戏", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）", "example": "xyz789" }, { "name": "HostUserId", "type": "string", "required": false, "description": "【多人游戏】游戏主机用户ID", "example": "abc123" } ], "required": [ "UserId" ] }, { "name": "StopPublishStream", "description": "停止云端推流", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）", "example": "639d069e-a13a-437a-a10b-64a33ecb8e79" } ], "required": [ "UserId" ] }, { "name": "SwitchGameArchive", "description": "切换游戏存档", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "游戏用户ID", "example": "161394323449" }, { "name": "GameId", "type": "string", "required": true, "description": "游戏ID", "example": "game-av2bl5r5" }, { "name": "GameArchiveUrl", "type": "string", "required": false, "description": "游戏存档Url", "example": "http://archive.cdn.com/user123.zip" }, { "name": "GameContext", "type": "string", "required": false, "description": "游戏相关参数", "example": "{\\\"ArchiveEnv\\\":\\\"tcg\\\",\\\"ArchiveCategoryId\\\":\\\"393\\\",\\\"ArchiveG" } ], "required": [ "UserId", "GameId" ] }, { "name": "SyncAndroidInstanceImage", "description": "同步安卓实例镜像到其他区域，当镜像的 AndroidInstanceImageState 为 NORMAL 时，镜像已经同步完成处于可用状态。", "status": "online", "parameters": [ { "name": "AndroidInstanceImageId", "type": "string", "required": true, "description": "安卓实例镜像 ID", "example": "image-abcd1234" }, { "name": "DestinationZones", "type": "array", "required": true, "description": "目的同步可用区列表", "example": "[\"ap-guangzhou-3\"]", "item_type": "string" } ], "required": [ "AndroidInstanceImageId", "DestinationZones" ] }, { "name": "SyncExecuteCommandOnAndroidInstances", "description": "在安卓实例上同步执行命令，仅支持1秒内可以返回结果的命令，例如：ls、cd。同时执行的实例数量不能过多，否则可能云api返回超时。不支持超过1秒无法返回或无法自主结束的命令，例如：top、vim，执行结果最大1KB", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"android_instance_id\"]", "item_type": "string" }, { "name": "Command", "type": "string", "required": true, "description": "shell 命令，必须是1秒内能自动结束的命令", "example": "ls -al; cat /etc/profile" } ], "required": [ "AndroidInstanceIds", "Command" ] }, { "name": "TrylockWorker", "description": "尝试锁定机器", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）", "example": "xyz789" }, { "name": "GameId", "type": "string", "required": true, "description": "游戏ID", "example": "game-abcd1234" }, { "name": "GameRegion", "type": "string", "required": false, "description": "游戏区域，ap-guangzhou、ap-shanghai、ap-beijing等，如果不为空，优先按照该区域进行调度分配机器", "example": "ap-guangzhou" }, { "name": "SetNo", "type": "integer", "required": false, "description": "【废弃】资源池编号", "example": "1" }, { "name": "UserIp", "type": "string", "required": false, "description": "【推荐填写】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验", "example": "125.127.178.228" }, { "name": "GroupId", "type": "string", "required": false, "description": "分组ID", "example": "cgg-1234abcd" } ], "required": [ "UserId", "GameId" ] }, { "name": "UninstallAndroidInstancesApp", "description": "卸载安卓实例应用", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "实例ID", "example": "cai-abcd1234", "item_type": "string" }, { "name": "AndroidAppId", "type": "string", "required": false, "description": "应用ID", "example": "app-testabcd" }, { "name": "PackageName", "type": "string", "required": false, "description": "包名", "example": "com.tencent.abc" } ], "required": [ "AndroidInstanceIds" ] }, { "name": "UploadFileToAndroidInstances", "description": "将文件下载到指定实例列表的实例上，每个实例都会从公网下载文件。如果您需要将同一个文件分发到多个实例，建议使用 DistributeFileToAndroidInstances 接口减少公网下载的流量。如果您需要将不同的文件下载到不同的实例，可考虑使用 UploadFilesToAndroidInstances 接口批量将不同文件下载到不同的实例。", "status": "online", "parameters": [ { "name": "AndroidInstanceIds", "type": "array", "required": true, "description": "安卓实例 ID 列表", "example": "[\"cai_xxx\"]", "item_type": "string" }, { "name": "FileURL", "type": "string", "required": true, "description": "文件下载 URL", "example": "https://xxx" }, { "name": "DestinationDirectory", "type": "string", "required": false, "description": "上传目标目录，只能上传到 /sdcard/ 目录或其子目录下", "example": "/sdcard/Download/" }, { "name": "DestinationFileName", "type": "string", "required": false, "description": "目标文件名", "example": "file_name" } ], "required": [ "AndroidInstanceIds", "FileURL" ] }, { "name": "UploadFilesToAndroidInstances", "description": "批量将不同的文件下载到不同的实例，每个实例下载文件都是从公网下载，建议只用在文件下载使用一次的场景。如果您需要将同一个文件分发到不同实例，建议使用 DistributeFileToAndroidInstances 接口。", "status": "online", "parameters": [ { "name": "Files", "type": "array", "required": false, "description": "上传文件信息列表", "example": "无", "item_type": "object", "children": [ { "name": "AndroidInstanceId", "type": "string", "required": false, "description": "安卓实例 ID", "example": "cai_a1b2" }, { "name": "FileURL", "type": "string", "required": false, "description": "文件上传 URL", "example": "https://xxx" }, { "name": "DestinationDirectory", "type": "string", "required": false, "description": "上传目标目录，只能上传到 /sdcard/ 目录或其子目录下", "example": "/sdcard/Download/" }, { "name": "DestinationFileName", "type": "string", "required": false, "description": "目标文件名", "example": "file_name" } ] } ], "required": [] } ] }