文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 服务器管理/ 批量更新服务器虚拟会话IP配置
更新时间:2024-09-05 GMT+08:00
分享

批量更新服务器虚拟会话IP配置

功能介绍

批量更新服务器虚拟会话IP配置,按需重启机器。

调试

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

URI

PATCH /v1/{project_id}/app-servers/actions/batch-update-tsvi

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目唯一标识。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

items

Array of objects

批量请求列表,一次请求数量区间 [1, 20]。

表4 items

参数

是否必选

参数类型

描述

id

String

服务器ID。

enable

Boolean

**⚠ 预留字段,不使用,是否启用虚拟IP功能与服务器组配置保持一致。 是否启用虚拟IP功能。 开关只在租户配置允许启用虚拟IP场景有效,否则忽略传值并设置为关闭。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 409

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 503

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

PATCH /v1/a4da8115c9d8464ead3a38309130523f/app-servers/actions/batch-update-tsvi

{
  "items" : [ {
    "id" : "3f791197-d166-4c8e-81e4-38c40ffc1989",
    "enable" : true
  }, {
    "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b",
    "enable" : true
  } ]
}

响应示例

状态码: 200

成功响应。

{
  "job_id" : "575768277444198400"
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

409

请求存在冲突无法处理该请求。

500

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

503

服务不可用。

错误码

请参见错误码

相关文档