重建桌面
功能介绍
批量重建桌面系统盘。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/desktops/rebuild
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
desktop_ids |
是 |
Array of strings |
计算机id列表。 |
|
image_type |
是 |
String |
镜像类型。 |
|
image_id |
是 |
String |
模板ID。 |
|
os_type |
否 |
String |
os类型。 |
|
delay_time |
否 |
Integer |
立即重建时给用户预留的保存数据的时间（单位：分钟）。 |
|
message |
否 |
String |
下发重建系统盘任务时，给用户发送的提示信息。 |
|
order_id |
否 |
String |
订单ID，包周期桌面重建系统盘，涉及收费镜像时需传。 |
|
enterprise_project_id |
否 |
String |
企业项目ID，默认"0。" |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
|
job_id |
String |
重建系统盘总任务id。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 409
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
{
"desktop_ids" : [ "string" ],
"image_type" : "string",
"image_id" : "string",
"os_type" : "string",
"delay_time" : 2147483647,
"message" : "string",
"order_id" : "string",
"enterprise_project_id" : "0"
}
响应示例
状态码： 200
正常。
{
"error_code" : "string",
"error_msg" : "string",
"encoded_authorization_message" : "string",
"job_id" : "string",
"get_job_endpoint" : "string",
"max_provision_time" : 0,
"min_provision_time" : 0,
"periodic_query_time" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
正常。 |
|
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
409 |
操作冲突。 |
|
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。
