停止一台或者多台云电脑。
接口说明
云电脑的状态必须为运行中(Running)。接口调用成功后,云电脑的状态将变更为已停止(Stopped)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 |
cn-hangzhou |
| ClientId |
string |
是 |
客户端生成的唯一 ID。 |
f4a0dc8e-1702-4728-9a60-95b27a35**** |
| SessionId |
string |
否 |
会话 ID。 |
cd45e873-650d-4d70-acb9-f996187a**** |
| LoginToken |
string |
否 |
登录凭证。 |
v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
| ClientOS |
string |
否 |
运行客户端的设备的操作系统。 |
Windows_NT 10.0.18363 x64 |
| ClientVersion |
string |
否 |
客户端版本。若使用无影客户端,可在客户端登录界面的关于对话框中查看该参数。 |
2.1.0-R-20210731.151756 |
| DesktopId |
array |
是 |
云电脑 ID 列表。可设置 1~20 个。 |
ecd-7w78ozhjcwa3u**** |
|
string |
否 |
云电脑 ID。 |
ecd-7w78ozhjcwa3u**** |
|
| ClientToken |
string |
否 |
保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 |
6ce412a8-399f-49f9-9518-66ee028a**** |
| SessionToken |
string |
否 |
登录凭证。 |
04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40 |
| OsUpdate |
boolean |
否 |
是否在停止云电脑时更新操作系统。 |
|
| Uuid |
string |
否 |
客户端唯一标识符。 |
91761ED27169E2FC564F29388E2D**** |
| ForceStop |
boolean |
否 |
是否强制关机。取值范围:
默认值:false。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息集合。 |
||
| RequestId |
string |
请求 ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
示例
正常返回示例
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。