接口说明
对指定id或者对指定节点IP的云手机更换带宽上限。 注意: 1. 本接口属于异步任务接口,返回结果只有任务id。查询该任务的执行状态需要客户配置回调信息,或者根据任务id调用“查询任务执行状态详情/列表”接口来实现; 2. 状态为“运行中”的云手机才能调用此接口; 3. 当前只有尊享版云手机才能更换带宽,带宽上限默认为300Mbps;
URL
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/maxbandwidth
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
req
|
OpenapiCloudPhoneSetMaxBandwidthReq
|
是
|
req |
|
callbackUrl
|
string
|
否
|
回调url,如http://192.168.0.1:5556/api/callback,needCallback为true才能生效 |
|
hostIps
|
<string> array
|
否
|
服务器IP列表 |
|
ids
|
<string> array
|
否
|
云手机实例ID列表 |
|
maxBandwidth
|
string
|
是
|
云手机带宽上限,单位Mbps。支持50Mbps、100Mbps、200Mbps、300Mbps。默认300Mbps |
|
needAuth
|
boolean
|
否
|
是否需要鉴权 |
|
needCallback
|
boolean
|
否
|
是否需要回调 |
请求示例
POST https://ecloud.10086.cn/api/openapi-cloudphone/api/v1/zycloudphone/resource/zh/phones/maxbandwidth
{
"needCallback":true,
"callbackUrl":"http://192.168.0.1:5556/api/callback",
"needAuth":true,
"ids":[
"1990335996257976322"
],
"maxBandwidth":200
}
返回参数
返回码: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":"01ad75d1-7f40-4491-8b9d-83bdb94a8ac5",
"state":"OK",
"body":[
{
"id":"1990335996257976322",
"jobId":"1991770289975296002",
"errorCode":null,
"errorMsg":null
}
]
}