云手机关机

接口说明

对指定id的云手机执行关机操作,云手机状态会变为“正在关机”,经过一段时间后变成“已关机”。 注意: 1. 本接口属于异步任务接口,返回结果只有任务id。查询该任务的执行状态需要客户配置回调信息,或者根据任务id调用“查询任务执行状态详情/列表”接口来实现; 2. 状态为“运行中”的云手机才能调用此接口;


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/close

请求参数

Body

参数名称
类型
必填
描述
req
OpenapiCloudPhoneStateChangeReq
是

req

callbackUrl
string
否

回调url,如http://192.168.0.1:5556/api/callback,needCallback为true才能生效

ids
<string> array
是

云手机实例ID列表

needAuth
boolean
否

是否需要鉴权

needCallback
boolean
否

是否需要回调

请求示例

POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/close
{
	"ids":[
		"1899654129611276290"
	],
	"needCallback":true,
	"callbackUrl":"http://192.168.0.1:5556/api/callback",
	"needAuth":true
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
<OpenapiCloudPhoneJobResultDto> array

响应体

errorCode
string

任务错误码

errorMsg
string

任务错误码说明

id
string

云手机ID

jobId
string

任务ID

errorCode
string

错误编码

errorMessage
string

错误信息

requestId
string

请求id

state
string

状态值

返回示例

返回码:200
OK
{
	"errorCode":"00000000",
	"errorMessage":"请求成功",
	"requestId":"0e07272c-e048-4cfd-a906-84cde990cb15",
	"state":"OK",
	"body":[
		{
			"id":"1899654129611276290",
			"jobId":"1900009898001137665",
			"errorCode":null,
			"errorMsg":null
		}
	]
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。