【旧版】更新实例 UpdatePod--云手机-火山引擎

文档中心

立即注册

导航

【旧版】更新实例 UpdatePod

最近更新时间：2024.06.17 19:36:16首次发布时间：2023.06.14 12:45:14

更新指定实例的属性信息，包括：

更改实例名称
实例镜像升级（暂不支持从高版本镜像更配为低版本镜像）
更改实例的套餐配置（需要在关机状态下更配，实例重启后生效）
更改实例的屏幕布局（需要在关机状态下更配，实例重启后生效）

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	UpdatePod
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
product_id	Query	string	是	实例所归属的业务 ID
pod_id	Query	string	否	实例 ID，指定该参数时，仅更新单个实例的属性信息	与 Body 参数中 `pod_id_list` / `tag_id` / `dc` 二选一

Body 参数

字段	类型	必填	说明
pod_name	string	否	实例名称
image_id	string	否	镜像 ID（注意：更新会引起实例重启；仅支持从低版本镜像升级为高版本镜像）
data_size	string	否	data 分区容量大小，仅支持扩容、不支持缩容；可选项： 4Gi 8Gi 16Gi 32Gi 64Gi 128Gi 256Gi
configuration_code	string	否	火山侧套餐 ID（注意：需要在关机状态下执行，实例重启后更新生效），可选项为： ultimate（旗舰型） enhanced（加强型） common（通用型） sample（入门型） basic（基础型） elementary（低配型）
display_layout_id	string	否	屏幕布局 ID，可通过调用 ListDisplayLayoutMini 接口获取（注意：需要在关机状态下执行，实例重启后更新生效）；可选的系统屏幕布局 ID 包括： single-display-landscape single-display-portrait single-display-portrait-720p
pod_id_list	[]string	否	实例 ID 列表，指定该参数时，批量更新多个实例的属性信息（批量操作时，pod_id_list、tag_id、dc 必须填一个；批量操作的最大实例数量为100)
tag_id	string	否	实例标签 ID，指定该参数时，批量更新已添加该分组标签的所有实例的属性信息（批量操作时，pod_id_list、tag_id、dc 必须填一个；批量操作的最大实例数量为100)
dc	string	否	实例机房，指定该参数时，批量更新属于该机房的所有实例的属性信息（批量操作时，pod_id_list、tag_id、dc 必须填一个；批量操作的最大实例数量为100)
force	bool	否	是否可在开机状态下强制更新实例镜像： true：可强制执行更新（会触发实例重启） false：不可强制执行更新（默认）
up_bandwidth_limit	int32	否	实例上行带宽上限（单位：Mbps；如设置为0，则不限速）
down_bandwidth_limit	int32	否	实例下行带宽上限（单位：Mbps；如设置为0，则不限速）
ip_white_list	String	否	配置白名单 IP，您可根据自身业务需求，自定义设置 IP。对白名单 IP 不限速，同时对 pod 访问的其他 IP 进行整体限制。目前仅支持配置 10 个白名单 IP。例如，`127.0.0.1,127.0.0.2` 说明如果设置 `up_bandwidth_limit` 和 `down_bandwidth_limit` 这两个参数，该 `ip_white_list` 参数生效。

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

示例

请求示例

POST https://open.volcengineapi.com?Action=UpdatePod
&Version=2022-08-01
&product_id=1591495366954xxxxxx
&pod_id=7294107154305xxxxxx
&<通过header传入的公共请求参数>

{
    "pod_name":"测试实例01",
    "configuration_code":"sample",
    "data_size":"8Gi",
    "up_bandwidth_limit":2,
    "down_bandwidth_limit":4
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdatePod",
        "Region": "cn-north-1",
        "RequestId": "20231026151***4831ECFE65C695",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": "success"
}

错误码

错误码	说明	操作建议
8030010	所属业务欠费关停	检查指定的业务 ID 已通过审核
8030007	业务存储不足	确保对应业务下有可订购存储
8030008	业务并发不足	确保对应业务下有可订购并发
8060003	正在操作实例, 上次操作完成前禁止再次操作	等待操作完成后重试
8060004	禁止操作实例	检查实例状态后重试
8060005	操作的实例数量超过批量操作上限	参考说明文档，检查可批量执行的实例数量上限，建议减少并发请求
8060013	实例对应镜像 ID 不存在	检查指定的镜像 ID 是否正确
8060014	实例镜像不能降级	升级实例镜像时，不支持从高版本镜像降级为低版本镜像