文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 桌面/ 变更规格
更新时间：2024-02-23 GMT+08:00
查看PDF
分享

变更规格

功能介绍

变更云桌面规格，只支持变更CPU和内存，不支持变更磁盘，不支持同规格互相变更。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/desktops/resize

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

否

String

发送的实体的MIME类型。
表3 请求Body参数

参数

是否必选

参数类型

描述

desktops

是

Array of ResizeDesktopData objects

桌面数据。支持批量按需类型桌面变更为同一规格。

product_id

是

String

套餐id。批量变更时，则变更为同一规格的虚拟机。

mode

是

String

是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP，如果桌面处于开机状态，会先关机再变更规格。
表4 ResizeDesktopData

参数

是否必选

参数类型

描述

desktop_id

否

String

桌面ID。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

jobs

Array of ResizeDesktopJobResponse objects

按需桌面变更规格返回的任务信息（jobs字段后续会下线，请使用job_id字段）。

job_id

String

变更规格任务id。
表6 ResizeDesktopJobResponse

参数

参数类型

描述

desktop_id

String

桌面ID。

job_id

String

任务ID。

状态码： 202

表7 响应Body参数

参数

参数类型

描述

jobs

Array of ResizeDesktopJobResponse objects

按需桌面变更规格返回的任务信息（jobs字段后续会下线，请使用job_id字段）。

job_id

String

变更规格任务id。
表8 ResizeDesktopJobResponse

参数

参数类型

描述

desktop_id

String

桌面ID。

job_id

String

任务ID。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 404

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 409

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

POST /v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/resize

{
  "desktops" : [ {
    "desktop_id" : "538946c2-7ff8-4444-b1bd-e9a1f8137b81"
  } ],
  "product_id" : "workspace.k.xlarge.2.linux",
  "mode" : "STOP_DESKTOP"
}

响应示例

状态码： 200

变更规格响应。

{
  "job_id" : "c566b960-69d1-44ec-9397-2172fdd01xxx",
  "jobs" : [ {
    "desktop_id" : "c566b960-69d1-44ec-9397-2172fdd015d9",
    "job_id" : "41162624-ba52-42f3-bdda-15c6d345ff60"
  } ]
}

状态码： 202

变更规格响应。

{
  "job_id" : "c566b960-69d1-44ec-9397-2172fdd01xxx",
  "jobs" : [ {
    "desktop_id" : "c566b960-69d1-44ec-9397-2172fdd015d9",
    "job_id" : "41162624-ba52-42f3-bdda-15c6d345ff60"
  } ]
}

状态码

状态码

描述

200

变更规格响应。

202

变更规格响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

409

操作冲突。

500

服务内部错误，具体返回错误码请参见错误码说明。

错误码

请参见错误码。

父主题： 桌面

相关文档