云手机

1. 云手机商品列表

  • Path: /api/v1/cloud-mobile/mobile-product-list

  • Method: POST

  • Content-Type:application/json

  • 接口描述:获取云手机商品列表。

  • 请求参数:无

执行成功返回

{
	"code": "",                     //结果码。0表示成功,其余为失败
	"data": [                       //业务数据
		{
			"billingType": 0,         //扣费方式:1-按需付费
			"id": 0,                 //产品ID
			"origRunPrice": 0,       //锚定运行费用
			"origStoragePrice": 0,    //锚定存储费用
			"productName": "",      //产品名称
			"runPrice": 0,           //运行费用
			"showCpu": "",           //CPU
			"showMemory": "",       //内存
			"showRegionId": 0,       //区域ID
			"showRegionName": "",   //区域
			"showStorage": "",        //存储
			"showSystem": "",        //系统
			"storagePrice": 0         //存储费用
		}
	],
	"msg": ""                        //结果信息
}

2. 云手机分页列表

  • Path:/api/v1/cloud-mobile/mobile-page
  • Method: POST
  • Content-Type:application/json
  • 接口描述:获取云手机分页列表。

请求参数

参数名称类型必传说明
adbStatusint查询ADB状态。1-开启 0-关闭
currentint分页第x页偏移量。默认为1
mobileIdsarray手机ids
namestring云手机名称
sizeint分页条数。默认10,最多200条
stateboolean云手机状态,true-开机,false-关机

请求示例

{
  "adbStatus": 0,   
  "current": 0,
  "mobileIds": [],
  "name": "",
  "size": 0,
  "state": true
}

执行成功返回

{
	"code": "",                     //结果码。0表示成功,其余表示失败
	"data": {                       //业务数据
		"list": [                     //返回数组
			{
				"adbStatus": 0,         //ADB状态。0-关闭,1-开启
				"billingStatus": 0,       //计费状态。1-正常,2-即将过期,3-已过期
				"billingType": 0,         //计费方式:1-按需付费,2-包月
				"createTime": "",        //创建时间
				"expiredTime": "",      //过期时间
				"lastPowerOnTime": "",  //最后开机时间
				"mobileId": 0,           //主键
				"name": "",             //手机名称
				"number": 0,            //序号
				"proxyTypeId": 0,        //代理类型id
				"remark": "",            //备注
				"serialNumber": 0,       //编号
				"status": 0,      //状态。-2-创建失败,-1-初始化状态,0-关机,1-开机使用中,2-设备占用中,3-设备开机未有人使用,4-开机中,5-恢复出厂中,6-重启中
				"tagId": 0,              //分组id
				"tagName": ""          //分组
			}
		],
		"total": 0                       //返回数组总数
	},
	"msg": ""                          //结果信息
}

3. 添加云手机

  • Path:/api/v1/cloud-mobile/add-mobile
  • Method: POST
  • Content-Type:application/json
  • 接口描述:可创建新的按需云手机(暂不支持创建按月使用的云手机)。

请求参数

参数名称类型必传说明
countint创建按需云手机的数量,默认为1
productIdint云手机商品ID

请求示例

{
  "count": 0,
  "productId": 0
}

执行成功返回

{
	"code": "",     //结果码。0表示成功,其余为失败
	"data": [],     //业务数据
	"msg": ""       //结果信息
}

4. 国家时区语言列表

  • Path:/api/v1/cloud-mobile/get-country-time-zone-language-list
  • Method: POST
  • Content-Type:application/json
  • 接口描述:获取云手机的国家时区语言列表。
  • 请求参数:无

执行成功返回

{
	"code": "",                     // 结果码。0表示成功,其余为失败
	"data": {                        //业务数据
		"countryList": [              //国家列表
			{
				"country": "",        //国家key。填代理时用的值
				"id": 0,                //id
				"showCountry": "",     //国家显示值
				"timeZoneVoList": [     //国家关联的时区 
					{
						"showTimeZone": "",      //时区显示值
						"timeZone": ""           // 时区key。填代理时用的值
					}
				]
			}
		],
		"languageList": [                //语言列表
			{
				"language": "",          //语言key。填代理时用的值
				"showLanguage": ""     //语言显示值
			}
		]
	},
	"msg": ""                           //结果信息
}

5. 批量开启云手机

  • Path:/api/v1/cloud-mobile/power-on-mobile
  • Method: POST
  • Content-Type:application/json
  • 接口描述:批量开启云手机。

请求参数

参数名称类型必传说明
mobileIdsarray云手机ID列表,限制20个ID

请求示例

{
  "mobileIds": []
}

执行成功返回

{
	"code": "",                        //结果码。0表示成功,其余为失败
	"data": {                          //业务数据
		"failResult": "",                //失败结果显示。不为空时展示
		"successCount": 0             //成功开机数
	},
	"msg": ""                         //结果信息
}

6. 批量关闭云手机

  • Path:/api/v1/cloud-mobile/shutdown-mobile
  • Method: POST
  • Content-Type:application/json
  • 接口描述:批量关闭云手机。

请求参数

参数名称类型必传说明
mobileIdsarray云手机ID列表,限制20个ID
checkboolean可强制关闭正在使用中的云手机(包括其他人正在使用的)。true-开启使用验证,false-不验证,默认值true

请求示例

{
 "check": true,
  "mobileIds": []
}

执行成功返回

{
	"code": "",                      //结果码。0表示成功,其余为失败
	"data": [                        //业务数据
		{
			"errorMsg": "",          //失败信息
			"mobileId": 0,           //云手机id
			"mobileName": "",       //云手机名称
			"status": 0              //状态。0-失败,1-成功
		}
	],
	"msg": ""                       //结果信息
}

7. 更新代理

  • Path:/api/v1/cloud-mobile/update-proxy
  • Method: POST
  • Content-Type:application/json
  • 接口描述:更新云手机代理。

请求参数

参数名称类型必传说明
asDynamicTypeint是否动态(网络设置)。1-静态,2-动态,默认1
automaticPositioningboolean是否自动定位(定位设置)。默认true
countrystring国家code(时区/语言设置)
dnsStrategy int DNS策略(网络设置)。0-跟随IP,1-DNS保护。默认0
followIpboolean 跟随ip(时区/语言设置)。默认true
latnumber维度(定位设置)
lngnumber经度(定位设置)
mobileIdint云手机ID
proxyAccountstring代理账号(网络设置)
proxyHoststring代理主机地址(网络设置)
proxyPasswordstring代理密码(网络设置)
proxyPortint代理端口(网络设置)
proxyTypeIdint代理类型(网络设置)。1-HTTP,2-HTTPS,4-Socks5,5-Oxylabsauto,6-Lumauto,7-Luminati,11-smartproxy
proxyTypeId2int代理类型2(网络设置)。proxyTypeId = 7时可设置 1-HTTP,2-HTTPS,4-Socks5。默认1
referenceCitystring参考城市(网络设置)
referenceCountryCodestring参考国家code(网络设置)
referenceRegionCodestring参考州code(网络设置)
timeZone string 时区(时区/语言设置)
ysjLanguagestring语言(时区/语言设置)
ipDatabaseChannelint代理查询渠道。支持设置查询渠道选项,1-IP2Location 2-DB-IP 3-MaxMind

请求示例

{
  "asDynamicType": 0,
  "automaticPositioning": true,
  "country": "",
  "dnsStrategy": 0,
  "followIp": true,
  "lat": 0,
  "lng": 0,
  "mobileId": 0,
  "proxyAccount": "",
  "proxyHost": "",
  "proxyPassword": "",
  "proxyPort": 0,
  "proxyTypeId": 0,
  "proxyTypeId2": 0,
  "referenceCity": "",
  "referenceCountryCode": "",
  "referenceRegionCode": "",
  "timeZone": "",
  "ysjLanguage": ""
}

执行成功返回

{
	"code": "",             //结果码。0表示成功,其余为失败
	"data": true,            //业务数据
	"msg": ""               //结果信息
}

8. 批量获取云手机ADB状态

  • Path:/api/v1/cloud-mobile/list-adb
  • Method: POST
  • Content-Type:application/json
  • 接口描述:批量获取云手机的ADB状态。

请求参数

参数名称类型必传说明
mobileIds array 云手机ID列表,限制20个ID

请求示例

{
  "mobileIds": []
}

执行成功返回

{
	"code": "",                     //结果码。0表示成功,其余为失败
	"data": [                       //业务数据
		{
			"adbIp": "",             //adb的ip
			"adbPassword": "",      //adb连接密码
			"adbPort": "",           //adb连接端口
			"mobileId": 0,           //云手机id
			"remark": "",            //获取失败备注信息
			"success": 0            //是否成功获取    1=是  0=否
		}
	],
	"msg": ""                       //结果信息
}

9. 批量更新云手机ADB状态

  • Path:/api/v1/cloud-mobile/batch-update-adb
  • Method: POST
  • Content-Type:application/json
  • 接口描述:批量更新云手机的ADB状态。

请求参数

参数名称类型必传说明
enableAdbboolean是否开启adb。true-开启,false-关闭
mobileIdsarray云手机ID列表,限制20个ID

请求示例

{
  "enableAdb": true,
  "mobileIds": []
}

执行成功返回

{
	"code": "",                    //结果码。0表示成功,其余为失败
	"data": [                      //业务数据
		{
			"mobileId": 0,         //云手机id
			"remark": "",          //获取失败备注信息
			"success": 0          //是否成功获取   1=是  0=否
		}
	],
	"msg": ""                     结果信息
}

10. 一键新机

  • Path:/api/v1/cloud-mobile/new-machine
  • Method: POST
  • Content-Type:application/json
  • 接口描述:执行云手机一键新机操作。

请求参数

参数名称类型必传说明
mobileIdint获取云手机ID

请求示例

{
  "mobileId": 0
} 

执行成功返回

{
	"code": "",                    结果码。0表示成功,其余为失败
	"data": true,                   业务数据
	"msg": ""                     结果信息
}

11. 获取一键新机状态及可用数量

  • Path:/api/v1/cloud-mobile/new-machine-status
  • Method: POST
  • Content-Type:application/json
  • 接口描述:获取云手机一键新机的状态及可用数量。

请求参数

参数名称类型必穿说明
mobileIdint云手机ID

请求示例

{
  "mobileId": 0
} 

执行成功返回

{
	"code": "",                      结果码。0表示成功,其余为失败
	"data": {                        业务数据
		"availableQuantity": 0,        当前周期一键新机可用次数
		"mobileId": 0,               云手机id
		"status": true,               一键新机状态 false-关闭 true-开启
		"totalQuantity": 0            当前周期一键新机总次数
	},
	"msg": ""                       结果信息
}

12. 上传文件

  • Path:/api/v1/cloud-mobile/upload-file
  • Method: POST
  • Content-Type:application/json
  • 接口描述:上传文件到云手机。

请求参数

参数名称类型 必传说明
downloadDeststring上传至云手机中的目录。如果仅一层目录不存在,将自动创建;如果多层目录不存在,无法自动创建
fileUrlstring文件地址
mobileIdint云手机ID

请求示例

{
  "downloadDest": "",
  "fileUrl": "",
  "mobileId": 0
} 

执行成功返回

{
	"code": "",                 结果码。0表示成功,其余为失败    
	"data": true,                业务数据
	"msg": ""                  结果信息
}

2023-11-03
0 0