cpv-service

Alert

查询告警历史

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/history

Method： GET

接口描述：
支持分页、状态过滤、时间范围查询和排序; 默认创建时间倒序

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Query

参数名称	参数类型	是否必须	示例	备注
offset	string	否		偏移量，为大于等于0的整数，表示查询该偏移量后面的所有资源，默认值为0
limit	string	否		每页返回的资源个数，取值范围：1~200（默认值为100），一般设置为10、20、50
status	string	否		告警状态：1（告警中）、2（已恢复）、3（已处理）、4（已失效）
type	string	否		告警类型：1（云机故障告警）、2（云机指标告警）
create_since	string	否		查询的起始时间戳
create_until	string	否		查询的结束时间戳

返回数据

名称	类型	是否必须	默认值	备注	其他信息
alerts	object []	否		告警列表，以实例ID维度	item 类型: object
alert_id	string	否		告警流水号
alert_rule	string	否		告警规则
alert_type	integer	否		告警类型 1（故障告警），2（指标告警）
create_time	string	否		首次告警时间
metric_value	string	否		告警时实际指标值
notify_cfg	object	否		告警通知对象
custom	object	否		自定义回调(可选)
url	string	是
email	object	否		邮箱(可选)
to	string []	是		收件人列表	最小数量: 1 item 类型: string
		否
lark	object	否		飞书(可选)
url	string	是
times	object	是		通知时段
end_time	string	是		结束时间
start_time	string	是		开始时间(格式示例：09:09:09)
wechat	object	否		企微(可选)
url	string	是
weekDays	integer []	是		通知周期（0：周日，1：周一，2：周二，3：周三，4：周四，5：周五，6：周六）	最小数量: 1 最大数量: 7 item 类型: integer
		否
policy	string	否		告警策略
recovered_time	string	否		告警恢复时间
status	integer	否		告警状态
target	string	否		告警对象
target_type	integer	否		对象类型
tenant_code	string	否		租户编码
update_time	string	否		告警时间
count	integer	否		总数
request_id	string	否		请求唯一ID

告警策略列表

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/policies

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
project_id		项目id

Query

参数名称	参数类型	是否必须	示例	备注
offset	string	否		偏移量
limit	string	否		返回条数（默认值100）

返回数据

名称	类型	是否必须	默认值	备注	其他信息
data	object []	否		当前页数据	item 类型: object
description	string	否		策略描述
name	string	是		告警策略名称
notification	object	是		告警通知配置
custom	object	否		自定义回调(可选)
url	string	是
email	object	否		邮箱(可选)
to	string []	是		收件人列表	最小数量: 1 item 类型: string
		否
lark	object	否		飞书(可选)
url	string	是
times	object	是		通知时段
end_time	string	是		结束时间
start_time	string	是		开始时间(格式示例：09:09:09)
wechat	object	否		企微(可选)
url	string	是
weekDays	integer []	是		通知周期（0：周日，1：周一，2：周二，3：周三，4：周四，5：周五，6：周六）	最小数量: 1 最大数量: 7 item 类型: integer
		否
phones	string []	否		云手机ID集(不超过1000个，监控类型为云机时必填)	最大数量: 1000 item 类型: string
		否
rules	object []	是		告警规则列表(不超过9条)	最小数量: 1 最大数量: 9 item 类型: object
for	integer	是		异常持续时间，当前可选项如下: 连续10分钟: 10，连续20分钟：20，连续30分钟：30，连续1小时：60	枚举: 10,20,30,60
frequency	integer	是		告警频率，当前可选项如下: 每10分钟一次: 10，每15分钟一次：15，每30分钟一次：30，每小时一次：60，每3小时一次：180，每6小时一次：360，每12小时一次：720，每天告警一次：1440	枚举: 10,15,30,60,180,360,720,1440
metric	string	是		指标名称
statistic	object	是		统计量
period	integer	否		计算周期，特征值类型大于1的需填充此项，当前可选项如下: 最近10分钟: 10，最近20分钟：20，最近30分钟：30，最近1小时：60，最近4小时：240，最近1天：1440	枚举: 10,20,30,60,240,1440
sample	integer	是		特征值（原始值：1，平均值：2，最大值：4，最小值：5）	枚举: 1,2,4,5
threshold	object	是		门限条件
operator	integer	是		比较符（>=：1，<=：2,>：3，<：4）< /span>	枚举: 1,2,3,4
value	number	是		阈值
targetKind	integer	是		监控对象类型，当前可选项：3-云机实例	枚举: 3
total	integer	否		数据总数

新建告警策略

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/policies

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id

Body

名称	类型	是否必须	默认值	备注	其他信息
description	string	否		策略描述
name	string	是		告警策略名称
notification	object	是		告警通知配置
custom	object	否		自定义回调(可选)
url	string	是
email	object	否		邮箱(可选)
to	string []	是		收件人列表	最小数量: 1 item 类型: string
		否
lark	object	否		飞书(可选)
url	string	是
times	object	是		通知时段
end_time	string	是		结束时间
start_time	string	是		开始时间(格式示例：09:09:09)
wechat	object	否		企微(可选)
url	string	是
weekDays	integer []	是		通知周期（0：周日，1：周一，2：周二，3：周三，4：周四，5：周五，6：周六）	最小数量: 1 最大数量: 7 item 类型: integer
		否
phones	string []	否		云手机ID集(不超过1000个，监控类型为云机时必填)	最大数量: 1000 item 类型: string
		否
rules	object []	是		告警规则列表(不超过9条)	最小数量: 1 最大数量: 9 item 类型: object
for	integer	是		异常持续时间，当前可选项如下: 连续10分钟: 10，连续20分钟：20，连续30分钟：30，连续1小时：60	枚举: 10,20,30,60
frequency	integer	是		告警频率，当前可选项如下: 每10分钟一次: 10，每15分钟一次：15，每30分钟一次：30，每小时一次：60，每3小时一次：180，每6小时一次：360，每12小时一次：720，每天告警一次：1440	枚举: 10,15,30,60,180,360,720,1440
metric	string	是		指标名称
statistic	object	是		统计量
period	integer	否		计算周期，特征值类型大于1的需填充此项，当前可选项如下: 最近10分钟: 10，最近20分钟：20，最近30分钟：30，最近1小时：60，最近4小时：240，最近1天：1440	枚举: 10,20,30,60,240,1440
sample	integer	是		特征值（原始值：1，平均值：2，最大值：4，最小值：5）	枚举: 1,2,4,5
threshold	object	是		门限条件
operator	integer	是		比较符（>=：1，<=：2,>：3，<：4）< /span>	枚举: 1,2,3,4
value	number	是		阈值
targetKind	integer	是		监控对象类型，当前可选项：3-云机实例	枚举: 3

返回数据

名称	类型	是否必须	默认值	备注	其他信息
id	string	否

删除告警策略

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/policies

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id

Body

名称	类型	是否必须	默认值	备注	其他信息
ids	string []	是			最小数量: 1 item 类型: string
		否

告警策略详情

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/policies/{id}

Method： GET

接口描述：

请求参数

路径参数

参数名称	示例	备注
project_id		项目id
id		策略ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
description	string	否		策略描述
name	string	是		告警策略名称
notification	object	是		告警通知配置
custom	object	否		自定义回调(可选)
url	string	是
email	object	否		邮箱(可选)
to	string []	是		收件人列表	最小数量: 1 item 类型: string
		否
lark	object	否		飞书(可选)
url	string	是
times	object	是		通知时段
end_time	string	是		结束时间
start_time	string	是		开始时间(格式示例：09:09:09)
wechat	object	否		企微(可选)
url	string	是
weekDays	integer []	是		通知周期（0：周日，1：周一，2：周二，3：周三，4：周四，5：周五，6：周六）	最小数量: 1 最大数量: 7 item 类型: integer
		否
phones	string []	否		云手机ID集(不超过1000个，监控类型为云机时必填)	最大数量: 1000 item 类型: string
		否
rules	object []	是		告警规则列表(不超过9条)	最小数量: 1 最大数量: 9 item 类型: object
for	integer	是		异常持续时间，当前可选项如下: 连续10分钟: 10，连续20分钟：20，连续30分钟：30，连续1小时：60	枚举: 10,20,30,60
frequency	integer	是		告警频率，当前可选项如下: 每10分钟一次: 10，每15分钟一次：15，每30分钟一次：30，每小时一次：60，每3小时一次：180，每6小时一次：360，每12小时一次：720，每天告警一次：1440	枚举: 10,15,30,60,180,360,720,1440
metric	string	是		指标名称
statistic	object	是		统计量
period	integer	否		计算周期，特征值类型大于1的需填充此项，当前可选项如下: 最近10分钟: 10，最近20分钟：20，最近30分钟：30，最近1小时：60，最近4小时：240，最近1天：1440	枚举: 10,20,30,60,240,1440
sample	integer	是		特征值（原始值：1，平均值：2，最大值：4，最小值：5）	枚举: 1,2,4,5
threshold	object	是		门限条件
operator	integer	是		比较符（>=：1，<=：2,>：3，<：4）< /span>	枚举: 1,2,3,4
value	number	是		阈值
targetKind	integer	是		监控对象类型，当前可选项：3-云机实例	枚举: 3

修改告警策略

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/policies/{id}

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id
id		策略ID

Body

名称	类型	是否必须	默认值	备注	其他信息
description	string	否		策略描述
name	string	是		告警策略名称
notification	object	是		告警通知配置
custom	object	否		自定义回调(可选)
url	string	是
email	object	否		邮箱(可选)
to	string []	是		收件人列表	最小数量: 1 item 类型: string
		否
lark	object	否		飞书(可选)
url	string	是
times	object	是		通知时段
end_time	string	是		结束时间
start_time	string	是		开始时间(格式示例：09:09:09)
wechat	object	否		企微(可选)
url	string	是
weekDays	integer []	是		通知周期（0：周日，1：周一，2：周二，3：周三，4：周四，5：周五，6：周六）	最小数量: 1 最大数量: 7 item 类型: integer
		否
phones	string []	否		云手机ID集(不超过1000个，监控类型为云机时必填)	最大数量: 1000 item 类型: string
		否
rules	object []	是		告警规则列表(不超过9条)	最小数量: 1 最大数量: 9 item 类型: object
for	integer	是		异常持续时间，当前可选项如下: 连续10分钟: 10，连续20分钟：20，连续30分钟：30，连续1小时：60	枚举: 10,20,30,60
frequency	integer	是		告警频率，当前可选项如下: 每10分钟一次: 10，每15分钟一次：15，每30分钟一次：30，每小时一次：60，每3小时一次：180，每6小时一次：360，每12小时一次：720，每天告警一次：1440	枚举: 10,15,30,60,180,360,720,1440
metric	string	是		指标名称
statistic	object	是		统计量
period	integer	否		计算周期，特征值类型大于1的需填充此项，当前可选项如下: 最近10分钟: 10，最近20分钟：20，最近30分钟：30，最近1小时：60，最近4小时：240，最近1天：1440	枚举: 10,20,30,60,240,1440
sample	integer	是		特征值（原始值：1，平均值：2，最大值：4，最小值：5）	枚举: 1,2,4,5
threshold	object	是		门限条件
operator	integer	是		比较符（>=：1，<=：2,>：3，<：4）< /span>	枚举: 1,2,3,4
value	number	是		阈值
targetKind	integer	是		监控对象类型，当前可选项：3-云机实例	枚举: 3

更新告警策略状态

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/policies/{id}/status

Method： PATCH

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id
id		策略ID

Body

名称	类型	是否必须	默认值	备注	其他信息
enabled	boolean	否

告警静默

基本信息

Path： /v1/{project_id}/cloud-phone/alerts/silences

Method： POST

接口描述：
告警静默，默认静默24H

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
alert_ids	string []	是			最小数量: 1 最大数量: 100 item 类型: string
		否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否			item 类型: object
alert_id	string	否
error_code	string	否		错误码
error_msg	string	否		错误说明
status	integer	否		任务状态。2： 成功;-1： 失败
request_id	string	否

Job

查询任务执行状态列表

基本信息

Path： /v1/{project_id}/cloud-phone/jobs

Method： GET

接口描述：
查询任务执行状态列表

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Query

参数名称	参数类型	是否必须	示例	备注
request_id	string	否		任务下发请求时响应的request_id。request_id和request_ids必须指定其中一个。request_id和request_ids同时指定的时候，以request_ids为准。
request_ids	string	否		任务下发请求时响应的多个request_id，用逗号分隔，最多不能超过20个。request_id和request_ids必须指定其中一个。request_id和request_ids同时指定的时候，以request_ids为准。
offset	string	否		偏移量为一个大于等于0整数，表示查询该偏移量后面的所有的资源数，默认值为0。
limit	string	否		每页返回的资源个数。取值范围：1~200（默认值为100），一般设置为10、20、50。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否			item 类型: object
begin_time	object	否		任务处理开始时间，时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。
time.Time	string	否
end_time	object	否		任务处理结束时间，时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。
time.Time	string	否
error_code	string	否		错误码
error_msg	string	否		错误说明
execute_msg	string	否		任务执行返回内容，最长4096个字节。
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机ID
server_id	string	否		云手机所在服务器ID
status	integer	否		任务状态。0: 等待中；1： 运行中;2： 成功;-1： 失败
request_id	string	否		请求的唯一标识ID

查询任务执行状态

基本信息

Path： /v1/{project_id}/cloud-phone/jobs/{job_id}

Method： GET

接口描述：
查询任务执行状态

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32
job_id		任务ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
begin_time	object	否		任务处理开始时间，时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。
time.Time	string	否
end_time	object	否		任务处理结束时间，时间格式为UTC，YYYY-MM-DDTHH:MM:SSZ。
time.Time	string	否
error_code	string	否		错误码
error_msg	string	否		错误说明
execute_msg	string	否		任务执行返回内容，最长4096个字节。
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机ID
request_id	string	否		请求的唯一标识ID
server_id	string	否		云手机所在服务器ID
status	integer	否		任务状态。0: 等待中；1： 运行中;2： 成功;-1： 失败

Phone

查询手机镜像

基本信息

Path： /v1/{project_id}/cloud-phone/phone-images

Method： GET

接口描述：
查询手机镜像

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Query

参数名称	参数类型	是否必须	示例	备注
offset	string	否		偏移量，为大于等于0的整数，表示查询该偏移量后面的所有资源，默认值为0
limit	string	否		每页返回的资源个数，取值范围：1~100（默认值为100），一般设置为10、20、50
image_type	string	否		镜像类型，不传默认为公共镜像；公共镜像：public；私有镜像：private；共享镜像：share；所有类型镜像：all

返回数据

名称	类型	是否必须	默认值	备注	其他信息
phone_images	object []	否		云手机规格列表	item 类型: object
gpu_version	string	否		支持的GPU驱动集
image_id	string	否		手机镜像唯一标识ID，不超过32个字节。
image_label	string	否		镜像适用的云手机规格。
image_name	string	否		手机镜像名称，不超过128个字节。
is_public	integer	否		镜像类型。1：公有镜像;2 ：私有镜像
is_support_encrypt	boolean	否		当前镜像是否支持文件级加密
os_name	string	否		手机操作系统，不超过36个字节。
os_type	string	否		镜像操作系统类型，不超过16个字节。
push_time	object	否		当前镜像推送时间
time.Time	string	否
request_id	string	否		请求的唯一标识ID

获取云手机规格列表

基本信息

Path： /v1/{project_id}/cloud-phone/phone-models

Method： GET

接口描述：
获取云手机规格列表

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Query

参数名称	参数类型	是否必须	示例	备注
offset	string	否		偏移量，为大于等于0的整数，表示查询该偏移量后面的所有资源，默认值为0
limit	string	否		每页返回的资源个数，取值范围：1~200（默认值为100），一般设置为10、20、50
status	string	否		规格状态，可选值为0或1，不传表示查询所有状态；规格状态 0：下线状态；1：正常使用

返回数据

名称	类型	是否必须	默认值	备注	其他信息
phone_models	object []	否		云手机规格列表	item 类型: object
cpu	integer	否		CPU核数
disk	integer	否		系统存储大小，单位：GiB
dpi	integer	否		每英寸点数
extend_spec	string	否		扩展描述，不超过512个字节
fps	string	否		渲染帧率
image_label	string	否		镜像类型，只支持如下类型：qemu_phone, cloud_phone, cloud_phone_1620, cloud_game, cloud_game_1620
memory	integer	否		内存大小，单位：MB
phone_capacity	integer	否		当前云手机规格包含的云手机个数
phone_model_name	string	否		云手机的规格名称，不超过64个字节
phone_model_version	integer	否		规格版本：0：规格1.0 1：规格2.0
product_type	integer	否		产品类型。0:云手机 1:云手游
resolution	string	否		分辨率，不超过16个字节
server_model_name	string	否		云手机服务器的规格名称，不超过64个字节
spec_code	string	否		规格名称，不超过64个字节
status	integer	否		规格状态；1表示正常使用状态；0表示已下线状态。已下线的规格不可用来购买云手机服务器
volume_mode	integer	否		手机物理磁盘是否独立。0：不独立 1：独立
request_id	string	否		请求的唯一标识ID

获取云手机列表

基本信息

Path： /v1/{project_id}/cloud-phone/phones

Method： GET

接口描述：
获取云手机列表

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Query

参数名称	参数类型	是否必须	示例	备注
offset	string	否		偏移量，为大于等于0的整数，表示查询该偏移量后面的所有资源，默认值为0
limit	string	否		每页返回的资源个数，取值范围：1~200（默认值为100），一般设置为10、20、50
phone_name	string	否		云手机名称，支持模糊查询;最大长度64;名称只支持英文字母、数字、汉字、下划线和中划线。
server_id	string	否		云手机服务器的唯一标识
status	string	否		云手机状态：1：创建中，2：运行中，3：重置中，4：重启中，5：删除中，6：冻结，7：正在关机，8：已关机，-5：重置失败，-6：重启失败，-7：手机异常，-8：创建失败，-9：关机失败，-10：删除失败

返回数据

名称	类型	是否必须	默认值	备注	其他信息
count	integer	否
phones	object []	否			item 类型: object
access_infos	object []	否		接入信息 // 服务映射到公网的访问端口	item 类型: object
access_port	integer	否		服务映射到公网的访问端口。
domain_name	string	否		域名
isp	string	否		运营商
listen_port	integer	否		云机内服务监听端口
phone_ip	string	否		云手机IP。
phone_ipv6	string	否		云手机IPv6 IP
public_ip	string	否		云手机服务器的公网IP，如果端口设置了非公网访问，该字段返回空字符串。
server_ip	string	否		云手机服务器的内网IP。
server_ipv6	string	否		云手机服务器IPv6 IP
server_port	integer	否		服务器端口。
type	string	否		自定义端口类型，不超过16个字节。
availability_zone	string	否		云手机服务器所在的可用区；冗余字段，避免连表查询降低查询性能
create_time	object	否		创建时间， 时间格式为UTC。
time.Time	string	否
group_id	string	否
has_encrypt	boolean	否		当前手机是否开启文件级加密
image_id	string	否		云手机镜像ID，不超过32个字节。
image_version	string	否		镜像版本。
imei	string	否		imei码。
metadata	object	否		订单以及产品相关信息。
order_id	string	否		产品ID，不超过64个字节。
product_id	string	否		订单ID，不超过64个字节。
outer_order_no	string	否		订购订单号
phone_id	string	否		云手机的唯一标识，不超过32个字节
phone_model_name	string	否		云手机规格名称，不超过64个字节。
phone_name	string	否		云手机的名称，不超过65个字符。
property	string	否		云手机属性
sales_status	integer	否
server_id	string	否		服务器UUID
status	integer	否		云手机状态。1：创建中，2：运行中，3：重置中，4：重启中，5：删除中，6：冻结，7：正在关机，8：已关机，-5：重置失败，-6：重启失败，-7：手机异常，-8：创建失败，-9：关机失败，-10：删除失败
tenant_id	string	否
traffic_type	string	否		手机路由类型。direct：默认路由；routing：路由到编码容器
type	integer	否		云手机类型。 0：普通云手机;1：试玩云手机
update_time	object	否		更新时间， 时间格式为UTC。
time.Time	string	否
vnc_enable	string	否		云手机是否开启VNC服务。 true：开启;false：不开启
volume_mode	integer	否		手机物理磁盘是否独立。 0：不独立;1：独立
request_id	string	否		请求的唯一标识ID

应用限制名单设置

基本信息

Path： /v1/{project_id}/cloud-phone/phones/app-limit

Method： POST

接口描述：
应用限制名单设置；实例维度的设置应用黑白名单接口；单个应用粒度root开关；该接口为异步接口。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
package_names	string []	否		非必传参数：包名列表,长度0-200;为空时表示清空。合法包名：最大长度128字节。只支持包含大小写字母、数字、下划线、点，其中不允许以数字和下划线开头，点不能作为结尾且包名中至少有一个点。	item 类型: string
		否
phone_ids	string []	是		必传参数：云手机ID列表,长度0-100；server_ids参数不存在时必选，同时存在只处理phone_ids。	item 类型: string
		否
type	integer	是		必传参数：1：应用安装白名单；2：应用安装黑名单；3：root应用白名单；4：root应用黑名单	枚举: 1,2,3,4

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

批量手机克隆

基本信息

Path： /v1/{project_id}/cloud-phone/phones/batch-clone

Method： POST

接口描述：
批量手机克隆；指定母云机，克隆至相同服务器规格，云手机规格的服务器
组合任务，通过 job_id 查询主任务状态；通过 request_id 查询所有任务状态

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
phone_id	string	是		必传参数：云手机ID。
server_ids	string []	是		必传参数：云手机服务器ID列表,长度1-20；	item 类型: string
		否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

批量重置云手机

基本信息

Path： /v1/{project_id}/cloud-phone/phones/batch-reset

Method： POST

接口描述：
批量重置云手机

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
image_id	string	否		非必传参数：云手机镜像ID,32个字节; 不传则使用当前镜像
is_data_mapping	boolean	否		非必传参数：是否需要数据映射；不传默认值为 true
phones	object []	是		必传参数：云手机列表	最小数量: 1 item 类型: object
phone_id	string	是		必传参数：云机ID
property	string	否		云手机属性列表

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

批量重启云手机

基本信息

Path： /v1/{project_id}/cloud-phone/phones/batch-restart

Method： POST

接口描述：
批量重启云手机

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
image_id	string	否		非必传参数：云手机镜像ID,32个字节; 不传则使用当前镜像
phones	object []	是		必传参数：云手机列表	最小数量: 1 item 类型: object
phone_id	string	是		必传参数：云机ID
property	string	否		云手机属性列表

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

关闭云手机

基本信息

Path： /v1/{project_id}/cloud-phone/phones/batch-stop

Method： POST

接口描述：
关闭云手机，该接口为异步接口；强制关闭，停止其他任务。
传 phone_ids 默认只处理 phone_ids；不传 phone_ids 时，默认处理 server_ids 下所有云手机。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
phone_ids	string []	否		非必传参数：云手机ID列表,长度0-100；server_ids参数不存在时必选，同时存在只处理phone_ids。	item 类型: string
		否
server_ids	string []	否		非必传参数：云手机服务器ID列表,长度0-20；phone_ids参数不存在时必选，同时存在只处理phone_ids。	item 类型: string
		否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

更新云手机属性

基本信息

Path： /v1/{project_id}/cloud-phone/phones/batch-update-property

Method： POST

接口描述：
部分云手机属性开放更新能力，部分属性无法更新，部分属性需要重启手机生效，属性约束请云手机属性列表。如果手机处于异常状态，属性更新后需恢复手机状态为运行中才可生效。该接口为异步接口。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
phones	object []	是		必传参数：云手机列表	最小数量: 1 item 类型: object
phone_id	string	是		必传参数：云机ID
property	string	否		云手机属性列表

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

云机对拷

基本信息

Path： /v1/{project_id}/cloud-phone/phones/copy

Method： POST

接口描述：
云机对拷；组合任务；该接口为异步接口。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
exclude_files	string []	否		非必传参数：不能导出数据的存储路径。exclude_files优先级比include_files高，如果冲突，exclude_files生效。 路径要求同include_files。	item 类型: string
		否
include_files	string []	否		非必传参数：需要导出数据的存储路径（空则为默认值："/data/data", "/data/app", "/data/media","/data/system","/data/local","/data/user","/data/user_de",），绝对路径(最大100个)，最大长度4096字节。仅支持导出/data和、cache目录下的数据。目前只支持大小写字母、数字、小数点（.）、斜线（/）、中划线（-）、下划线（_）、加号（+）、井号（#）、星号（*）、等号这些字符。	item 类型: string
		否
reset	boolean	是		必传参数：在对拷完成后，源云机是否要执行一次恢复出厂；建议reset为true，如果reset为 false，两个包含着同样数据的云机启动，可能会触发风控
source_phone_id	string	是		必传参数：源云机ID，32字节
target_phone_id	string	是		必传参数：目标云机ID，32字节

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

获取云手机详情

基本信息

Path： /v1/{project_id}/cloud-phone/phones/{phone_id}

Method： GET

接口描述：
获取云手机详情

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32
phone_id		云手机唯一标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
access_infos	object []	否		接入信息 // 服务映射到公网的访问端口	item 类型: object
access_port	integer	否		服务映射到公网的访问端口。
domain_name	string	否		域名
isp	string	否		运营商
listen_port	integer	否		云机内服务监听端口
phone_ip	string	否		云手机IP。
phone_ipv6	string	否		云手机IPv6 IP
public_ip	string	否		云手机服务器的公网IP，如果端口设置了非公网访问，该字段返回空字符串。
server_ip	string	否		云手机服务器的内网IP。
server_ipv6	string	否		云手机服务器IPv6 IP
server_port	integer	否		服务器端口。
type	string	否		自定义端口类型，不超过16个字节。
availability_zone	string	否		云手机服务器所在的可用区；冗余字段，避免连表查询降低查询性能
create_time	object	否		创建时间， 时间格式为UTC。
time.Time	string	否
group_id	string	否
has_encrypt	boolean	否		当前手机是否开启文件级加密
image_id	string	否		云手机镜像ID，不超过32个字节。
image_version	string	否		镜像版本。
imei	string	否		imei码。
metadata	object	否		订单以及产品相关信息。
order_id	string	否		产品ID，不超过64个字节。
product_id	string	否		订单ID，不超过64个字节。
outer_order_no	string	否		订购订单号
phone_data_volume	object	否
volume_size	integer	否
volume_type	string	否
phone_id	string	否		云手机的唯一标识，不超过32个字节
phone_model_name	string	否		云手机规格名称，不超过64个字节。
phone_name	string	否		云手机的名称，不超过65个字符。
property	string	否		云手机属性
request_id	string	否
sales_status	integer	否
server_id	string	否		服务器UUID
status	integer	否		云手机状态。1：创建中，2：运行中，3：重置中，4：重启中，5：删除中，6：冻结，7：正在关机，8：已关机，-5：重置失败，-6：重启失败，-7：手机异常，-8：创建失败，-9：关机失败，-10：删除失败
tenant_id	string	否
traffic_type	string	否		手机路由类型。direct：默认路由；routing：路由到编码容器
type	integer	否		云手机类型。 0：普通云手机;1：试玩云手机
update_time	object	否		更新时间， 时间格式为UTC。
time.Time	string	否
vnc_enable	string	否		云手机是否开启VNC服务。 true：开启;false：不开启
volume_mode	integer	否		手机物理磁盘是否独立。 0：不独立;1：独立

ADB

ADB执行命令

基本信息

Path： /v1/{project_id}/cloud-phone/phones/commands

Method： POST

接口描述：
ADB执行命令

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
command	string	是		必传参数：push推动文件；shell异步执行adb命令；install安装apk；uninstall卸载apk；install-multiple批量安装；	枚举: push,shell,install,uninstall,install-multiple
content	string	是		必传参数：push:文件名称（tar）；shell:待执行的命令；install apk文件；uninstall卸载apk名称；最大长度为1024字节，只支持大小写字母、数字、下划线（_）、点（.）、斜线（/）、冒号（:）、中划线（-）。shell增加 | 及 & 符号；
phone_ids	string []	否		非必传参数：云手机ID列表,长度0-100；server_ids参数不存在时必选，同时存在只处理phone_ids。	item 类型: string
		否
server_ids	string []	否		非必传参数：云手机服务器ID列表,长度0-20；phone_ids参数不存在时必选，同时存在只处理phone_ids。	item 类型: string
		否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

Server

查询云手机服务器规格列表

基本信息

Path： /v1/{project_id}/cloud-phone/server-models

Method： GET

接口描述：
查询云手机服务器规格列表

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Query

参数名称	参数类型	是否必须	示例	备注
product_type	string	否		产品类型, 0：云手机; 1：云手游

返回数据

名称	类型	是否必须	默认值	备注	其他信息
request_id	string	否
server_models	object []	否			item 类型: object
cpu	integer	否		云手机服务器的CPU核数。
extend_spec	object	否		云手机服务器的属性描述，不超过512个字节。
bms_flavor	string	否		云手机服务器bms规格。
cpu	string	否		云手机服务器cpu类型。
disk	string	否		云手机服务器磁盘类型。
gpu	string	否		云手机服务器gpu类型。
gpu_count	integer	否		云手机服务器gpu数量。
memory	string	否		云手机服务器内存类型。
network_interface	string	否		云手机服务器网络类型。
numa_count	integer	否		云手机服务器numa数量。
free_size	integer	否		服务器磁盘的免费配额，单位G。
memory	integer	否		云手机服务器的内存大小，单位G。
product_type	integer	否		产品类型。0：云手机;1：云手游
server_model_name	string	否		云手机服务器的规格名称，不超过64字节。
server_type	string	否		云手机服务器的型号，如Hi1616。不超过32字节。

查询云手机服务器列表

基本信息

Path： /v1/{project_id}/cloud-phone/servers

Method： GET

接口描述：
查询云手机服务器列表

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Query

参数名称	参数类型	是否必须	示例	备注
offset	string	否		偏移量，为大于等于0的整数，表示查询该偏移量后面的所有资源，默认值为0
limit	string	否		每页返回的资源个数，取值范围：1~200（默认值为100），一般设置为10、20、50
server_name	string	否		云手机服务器名称，支持模糊查询;最大长度64;名称只支持英文字母、数字、汉字、下划线和中划线。
server_id	string	否		云手机服务器的唯一标识
network_version	string	否		云手机服务器是否为自定义网络标识。v1：系统定义网络的云手机服务器；v2：自定义网络的云手机服务器
phone_model_name	string	否		手机规格名称
create_since	string	否		查询的起始时间戳
create_until	string	否		查询的结束时间戳
status	string	否		服务器状态。2：异常，5：正常，8：冻结，10：关机，11：关机中，12：关机失败，13：开机中，14：维护中，15：服务器切换云手机规格中；16：重启中；17：重启失败

返回数据

名称	类型	是否必须	默认值	备注	其他信息
count	integer	否
request_id	string	否		请求的唯一标识ID
servers	object []	否			item 类型: object
addresses	object []	否		云手机服务器的IP相关信息。	item 类型: object
domain_name	string	否		域名
isp	string	否		运营商
public_ip	string	否		云手机服务器的公网IP
server_ip	string	否		云手机服务器的内网IP
availability_zone	string	否		云手机服务器所在的可用区。
cidr	string	否		云手机服务器所属虚拟私有云（简称VPC）的网段。网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR。
create_time	object	否		创建时间， 时间格式为UTC。
time.Time	string	否
enterprise_project_id	string	否		云手机服务器所属企业项目ID。
hardware_info	object	否		服务器物理信息。
bmc_ip	string	否		BMC IP
bmc_mac	string	否		BMC MAC
cabinet	string	否		机柜
chassis_sn	string	否		整机序列号
lan0_ip	string	否		LAN0 IP
lan0_mac	string	否		LAN0 MAC
lan1_ip	string	否		LAN1 IP
lan1_mac	string	否		LAN1 MAC
mb_sn	string	否		主板序列号
position	string	否		机柜位置
room	string	否		机房名称
supplier	string	否		供应商
keypair_name	string	否		连接云手机所使用的密钥对的名称，不超过64个字节。
metadata	object	否		订单以及产品相关信息。
charging_mode	integer	否		计费类型。 0：包周期
order_id	string	否		产品ID，不超过64个字节。
product_id	string	否		订单ID，不超过64个字节。
network_version	string	否		是否为自定义网络的云手机服务器标识。"v1"，非自定义网络的云手机服务器。 "v2"，自定义网络的云手机服务器。支持按照网络版本字段进行筛选。
phone_model_name	string	否		云手机规格名称，不超过64个字节。
server_id	string	否		云手机所在的服务器ID，不超过32个字节。
server_model_name	string	否		云手机服务器规格名称，不超过64个字节。
server_name	string	否		云手机服务器名称，不超过65字符，只支持英文字母、数字、汉字、下划线和中划线。
status	integer	否		服务器状态。2：异常，5：正常，8：冻结，10：关机，11：关机中，12：关机失败，13：开机中，14：维护中，15：服务器切换云手机规格中；16：重启中；17：重启失败
subnet_cidr	string	否		云手机服务器所属子网网段。网络版本 network_version 取值为“v2”时，表示租户创建服务器时指定子网的 CIDR; 取值为“v1”时，表示云手机服务器所属资源租户的子网CIDR。
subnet_id	string	否		云手机服务器所属子网的ID。仅在网络版本 network_version 取值为“v2”时，该取值表示租户创建服务器时指定子网的 ID，网络版本取值为“v1”时，该字段表示云手机服务器所属资源租户的子网ID。
update_time	object	否		更新时间， 时间格式为UTC。
time.Time	string	否
version_info	object	否
agent_version	string	否
gpu_version	string	否
kernel_version	string	否
vpc_cidr	string	否		云手机服务器所属虚拟私有云（简称VPC 网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR
vpc_id	string	否		云手机服务器所属虚拟私有云（简称VPC）的ID。 网络版本network_version取值为“v1”时，表示云手机服务器所属资源租户的VPC ID；取值为“v2”时，表示租户创建服务器时指定VPC的 VPC ID。

批量重启云手机服务器

基本信息

Path： /v1/{project_id}/cloud-phone/servers/batch-restart

Method： POST

接口描述：
批量重启云手机服务器

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
server_ids	string []	是		必传参数：云手机服务器ID列表。	最小数量: 1 item 类型: string
		否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

批量关闭云手机服务器

基本信息

Path： /v1/{project_id}/cloud-phone/servers/batch-stop

Method： POST

接口描述：
批量关闭云手机服务器

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

路径参数

参数名称	示例	备注
project_id		项目id，长度32

Body

名称	类型	是否必须	默认值	备注	其他信息
server_ids	string []	是		必传参数：云手机服务器ID列表。	最小数量: 1 item 类型: string
		否

返回数据

名称	类型	是否必须	默认值	备注	其他信息
jobs	object []	否		任务信息	item 类型: object
error_code	string	否		错误码
error_msg	string	否		错误说明
job_id	string	否		任务的唯一标识
phone_id	string	否		云手机的ID，32个字符,创建任务时无PhoneID
server_id	string	否		服务器的ID，32个字符,适用于下发server_ids参数，服务器内部所有phone都下发任务场景
request_id	string	否		请求的唯一标识ID

查询云手机服务器详情

基本信息

Path： /v1/{project_id}/cloud-phone/servers/{server_id}

Method： GET

接口描述：
根据server_id查询云手机服务器的详细信息。

请求参数

路径参数

参数名称	示例	备注
project_id		项目id，长度32
server_id		云手机服务器的唯一标识

返回数据

名称	类型	是否必须	默认值	备注	其他信息
addresses	object []	否		云手机服务器的IP相关信息。	item 类型: object
domain_name	string	否		域名
isp	string	否		运营商
public_ip	string	否		云手机服务器的公网IP
server_ip	string	否		云手机服务器的内网IP
availability_zone	string	否		云手机服务器所在的可用区。
cidr	string	否		云手机服务器所属虚拟私有云（简称VPC）的网段。网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR。
create_time	object	否		创建时间， 时间格式为UTC。
time.Time	string	否
enterprise_project_id	string	否		云手机服务器所属企业项目ID。
hardware_info	object	否		服务器物理信息。
bmc_ip	string	否		BMC IP
bmc_mac	string	否		BMC MAC
cabinet	string	否		机柜
chassis_sn	string	否		整机序列号
lan0_ip	string	否		LAN0 IP
lan0_mac	string	否		LAN0 MAC
lan1_ip	string	否		LAN1 IP
lan1_mac	string	否		LAN1 MAC
mb_sn	string	否		主板序列号
position	string	否		机柜位置
room	string	否		机房名称
supplier	string	否		供应商
keypair_name	string	否		连接云手机所使用的密钥对的名称，不超过64个字节。
metadata	object	否		订单以及产品相关信息。
charging_mode	integer	否		计费类型。 0：包周期
order_id	string	否		产品ID，不超过64个字节。
product_id	string	否		订单ID，不超过64个字节。
network_version	string	否		是否为自定义网络的云手机服务器标识。"v1"，非自定义网络的云手机服务器。 "v2"，自定义网络的云手机服务器。支持按照网络版本字段进行筛选。
phone_model_name	string	否		云手机规格名称，不超过64个字节。
request_id	string	否		请求的唯一标识ID
server_id	string	否		云手机所在的服务器ID，不超过32个字节。
server_model_name	string	否		云手机服务器规格名称，不超过64个字节。
server_name	string	否		云手机服务器名称，不超过65字符，只支持英文字母、数字、汉字、下划线和中划线。
status	integer	否		服务器状态。2：异常，5：正常，8：冻结，10：关机，11：关机中，12：关机失败，13：开机中，14：维护中，15：服务器切换云手机规格中；16：重启中；17：重启失败
subnet_cidr	string	否		云手机服务器所属子网网段。网络版本 network_version 取值为“v2”时，表示租户创建服务器时指定子网的 CIDR; 取值为“v1”时，表示云手机服务器所属资源租户的子网CIDR。
subnet_id	string	否		云手机服务器所属子网的ID。仅在网络版本 network_version 取值为“v2”时，该取值表示租户创建服务器时指定子网的 ID，网络版本取值为“v1”时，该字段表示云手机服务器所属资源租户的子网ID。
update_time	object	否		更新时间， 时间格式为UTC。
time.Time	string	否
version_info	object	否
agent_version	string	否
gpu_version	string	否
kernel_version	string	否
vpc_cidr	string	否		云手机服务器所属虚拟私有云（简称VPC 网络版本 network_version 取值为“v1”时，表示云手机服务器所属资源租户的VPC CIDR；取值为“v2”时，表示租户创建服务器时指定 VPC 的 VPC CIDR
vpc_id	string	否		云手机服务器所属虚拟私有云（简称VPC）的ID。 网络版本network_version取值为“v1”时，表示云手机服务器所属资源租户的VPC ID；取值为“v2”时，表示租户创建服务器时指定VPC的 VPC ID。