You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
【旧版】实例管理
【旧版】参数定义
复制全文
下载 pdf
【旧版】参数定义

Pod 定义

说明

Pod 为一个云手机实例。

参数列表

字段
类型
说明
product_idstring实例所属业务 ID
pod_idstring实例 ID
pod_namestring自定义实例名称
image_idstring镜像 ID
image_namestring镜像名称
tagTag与实例绑定的标签信息
dc_infoDc机房信息
intranet_ipstring实例的内网 IP
configurationConfiguration实例套餐信息
display_layout_idstring屏幕布局 ID

display_status

map<string, int32>

屏幕推流状态(key 为屏幕 ID;value 为推流状态,参考以下 Status 定义
注:通过 DetailPod 接口查询时返回;通过 ListPod 接口查询时返回的值无实际意义,可忽略

adb_status

int

代表实例 ADB 开启状态:

  • 1(开启)

  • 2(关闭)

adb

string

ADB 地址,空表示未开启 ADB,例如: 123.33.123.12:1234

adb_expire_timeint64ADB 过期时间(小于等于0为无过期时间)

online

int32

实例在线状态:

  • 0(开机中)

  • 1(开机完成)

  • 2(关机完成)

  • 3(关机中)

  • 4(重启中)

stream_status

int32

实例推流状态:

  • 0(空闲)

  • 1(推流中)

  • 2(就绪)

data_sizestring实例的用户存储分区大小(即 data 分区容量大小)
data_size_usedstring实例已使用的存储大小
up_bandwidth_limitint32实例上行带宽上限(单位:Mbps)
down_bandwidth_limitint32实例下行带宽上限(单位:Mbps)
create_atint64实例创建时间

aosp_version

string

实例镜像版本:

  • 10(AOSP 10)

  • 11(AOSP 11)

authority_status

int32

实例授权运维状态:

  • 1(未授权)

  • 2(已授权)

authority_expire_timeint64实例授权运维过期时间
ip_white_liststringIP 白名单列表

Dc 定义

说明

机房信息。

参数列表

字段类型说明
dcstring机房 ID
dc_namestring机房名称
regionstring区域
ispint32运营商

Status 定义

说明

云手机实例屏幕推流状态。

参数列表

状态码(十六进制)状态码(十进制)名称说明
0x100256空闲实例处于空闲状态
0x300768已使用已使用(实例已经被分配给某个客户端使用)
0x303771推流中实例正在推流
0x310784推流结束客户端正常使用完毕
0x311785超时客户端超时未加入释放
0x312786无操作客户端无操作释放
0x315789异常推流异常
0x316790异常客户端异常退出
0x4001024故障故障
0x4081032重置中实例正在被重置
0x4091033重启中实例正在被重启

Display 定义

说明

云手机实例推流屏幕描述。

参数列表

字段
类型
说明
client_widthint32客户端屏幕宽度,如为空,则默认客户端屏幕比例与云机一致
client_heightint32客户端屏幕高度,如为空,则默认客户端屏幕比例与云机一致

rotation

int32

屏幕横竖屏:

video_stream_profile_idint32当前屏幕视频流清晰度档位 ID,参考:云手机清晰度档位说明
app_idstring指定启动的应用 ID,如不指定,则由具体调度逻辑调度 Pod
package_namestring以包名启动

PodAppInfo 定义

说明

云手机实例上安装的应用信息。

参数列表

字段
类型
说明
app_idstring应用 ID
app_namestring应用名称

app_source

int

应用安装方式:

  • 0 => 通过平台上传安装

  • 1 => 非平台上传安装

package_namestring应用包名
version_idint64应用版本 ID
version_id_strstring应用版本 ID
version_codeint64应用版本号
version_namestring应用版本名称

rotation

int32

屏幕横竖屏:

  • 0 => 竖屏

  • 270 => 横屏

icon_urlstring应用图标 URL

install_type

int32

应用安装类型:

  • 0 => 机身存储安装

  • 1 => 共享安装

install_status

int32

应用安装状态:
513(0x201) => 正在安装
516(0x204) => 正在下载
528(0x210) => 安装完成
1024(0x400) => 安装失败
1280(0x500) => 卸载中
1281(0x501) => 已卸载

running_state

int32

运行状态:

  • 0 => 未运行
  • 1 => 前台运行
  • 2 => 后台运行

Settings 定义

说明

云手机实例 Settings 信息。

参数列表

字段
类型
必选
说明

settings_type

string

设置类型,可选:

  • global

  • secure

  • system

settings_namestring属性名称,已可修改的 Settings 属性及属性值,参考 附件说明
settings_valueinterface{}属性值

settings_value_type

string

属性值数据类型,可选:

  • int

  • long

  • string

  • float

  • bool

System Properties 定义

说明

云手机实例系统属性信息。

参数列表

字段
类型
必选
说明

system_property_name

string

属性名称,已可修改的系统属性及属性值,参考 附件说明

system_property_valueinterface{}属性值

system_property_value_type

string

属性值数据类型,可选:

  • int

  • long

  • string

  • float

  • bool

PodSpec 定义

说明

批量创建实例时的实例配置信息。

参数列表

字段
类型
必选
说明

pod_name

string

批量创建实例时的实例名称前缀。例:如 pod_name 指定为 abc,则创建的实例名称为:abc_1、abd_2 等

image_idstring镜像 ID(如不指定则使用业务镜像 ID;如业务镜像 ID 为空,使用平台提供的官方标准镜像)
dcstring机房 ID(如指定,则在此机房创建实例)

configuration_code

string

运行资源的套餐规格 ID,可选项为:

  • ultimate(旗舰型)

  • enhanced(加强型)

  • common(通用型)

  • sample(入门型)

  • basic(基础型)

  • elementary(低配型)

data_size

string

创建实例的用户存储分区大小(即 data 分区容量大小),可选的容量如下(容量大小和单位不可自定义):

  • 4Gi

  • 8Gi

  • 16Gi

  • 32Gi

  • 64Gi

  • 128Gi

  • 256Gi

注:如不指定,则默认使用 8Gi 容量(建议调用方在调用时,结合实际业务情况,按需填写存储大小,默认 8Gi 容量对部分业务会偏小)

display_layout_idstring屏幕布局,全局屏幕配置
apply_numint64创建实例数量
startbool创建完成后是否立即启动,默认为否

overlay_settings

list

实例初始化 Settings 属性;详细信息,参考 附件说明

overlay_property

list

实例初始化系统属性,非持久化,立即生效,重启实例后失效;详细信息,参考 附件说明

overlay_persist_property

list

实例初始化系统属性,持久化,重启实例后生效;详细信息,参考 附件说明
说明:适用于只读系统属性,或 AOSP 原生非持久化的系统属性的修改,如 ro.product.model

tag_idstring自定义标签
up_bandwidth_limitint32实例上行带宽上限(单位:Mbps;如设置为0,则不限速)
down_bandwidth_limitint32实例下行带宽上限(单位:Mbps;如设置为0,则不限速)

ip_white_list

String

配置白名单 IP,您可根据自身业务需求,自定义设置 IP。对白名单 IP 不限速,同时对 pod 访问的其他 IP 进行整体限制。目前仅支持配置 10 个白名单 IP。例如,127.0.0.1,127.0.0.2

说明

如果设置 up_bandwidth_limit 和 down_bandwidth_limit 这两个参数,该 ip_white_list 参数生效。

最近更新时间:2024.06.17 19:36:16
这个页面对您有帮助吗?
有用
有用
无用
无用