更新云机 UpdateHost--云手机-火山引擎

文档中心

立即注册

导航

云手机

更新云机 UpdateHost

最近更新时间：2025.03.21 16:22:51首次发布时间：2024.03.04 19:40:02

更新一个或多个指定云机的信息。当前仅支持更改云机上可运行的实例规格。

使用说明

如需更改云机上运行的实例规格，请先删除待更配的云机上所有已创建的实例，再调用本接口。

注意事项

注意

在调用本接口前，请先确认当前业务类型是否为本地存储。“云机”是本地存储业务的资源订购单位，因此，本接口仅适用于本地存储业务。对于采用云盘存储方案的业务，本接口不适用，请勿尝试调用。
仅支持同一规格云机内的实例规格调整，不可跨云机规格变更。例如，“旗舰型Plus”实例仅可变更为同云机规格下的其他实例规格（如“加强型 Plus”），不可降级为“旗舰型”或升级为“旗舰型Pro”。如需降级或升级，请重新订购其他规格的云机。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateHost&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateHost`	接口名称。当前 API 的名称为 `UpdateHost`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1749281594201xxxxxx`	业务 ID。可在云手机控制台 > 业务管理 > 业务详情中获取。
HostIdList	Array of String	是	`["7337159054625xxxxxx","7337159054626xxxxxx"]`	待更新云机 ID 列表。可通过调用 ListHost 接口获取。
ConfigurationCode	String	否	`ultimate`	云机上期望运行的实例规格 ID。云机规格和实例规格的详细对应关系参看本地存储实例规格列表。注意若使用本参数更新实例规格，必须确保通过 `HostIdList` 传入的多个云机属同一规格。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	说明
Result	String	`success`	返回结果。

请求示例

POST https://open.volcengineapi.com?Action=UpdateHost&Version=2023-10-30
{
    "ProductId": "1749281594201xxxxxx",
    "HostIdList": [
        "7332747535309xxxxxx"
    ],
    "ConfigurationCode": "basic"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateHost",
        "Region": "cn-north-1",
        "RequestId": "2024022015***422800F76B50654B4",
        "Service": "ACEP",
        "Version": "2023-10-30"
    },
    "Result": "success"
}

错误码

下表列举了本接口特有的错误码。您可访问公共错误码，获取更多错误码信息。

状态码	错误码	错误信息	说明
400	InvalidParameter.RequestInvalidParameter	请求参数非法	1000007
400	InvalidParameter.PodOnHostNotZero	云机上仍存在实例，请删除实例后再更新云机	80130004