You need to enable JavaScript to run this app.
文档中心
文档控制台
注册
云手机

云手机

复制全文
下载 pdf
【旧版】云机管理
【旧版】更新云机 UpdateHost
复制全文
下载 pdf
【旧版】更新云机 UpdateHost

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

使用说明

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

注意事项

注意

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ProductIdString1749281594201xxxxxx业务 ID。可在云手机控制台 > 业务管理 > 业务详情中获取。
HostIdListArray of String["7337159054625xxxxxx","7337159054626xxxxxx"]待更新云机 ID 列表。可通过调用 ListHost 接口获取。

ConfigurationCode

String

ultimate

云机上期望运行的实例规格 ID。云机规格和实例规格的详细对应关系参看本地存储实例规格列表

注意

若使用本参数更新实例规格,必须确保通过 HostIdList 传入的多个云机属同一规格。

返回参数

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

参数类型示例值说明
ResultStringsuccess返回结果。

请求示例

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"
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.RequestInvalidParameter请求参数非法1000007
400InvalidParameter.PodOnHostNotZero云机上仍存在实例,请删除实例后再更新云机80130004
最近更新时间:2026.03.27 11:03:39
这个页面对您有帮助吗?
有用
有用
无用
无用