【旧版】创建实例 CreatePod--云手机-火山引擎

文档中心

立即注册

导航

【旧版】创建实例 CreatePod

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

创建指定套餐规格配置的实例，支持单个实例创建及批量实例创建：

如不指定 pod_spec_list 参数，则创建单个实例。
如指定 pod_spec_list 参数，则批量创建多个实例，且 pod_spec_list 中指定的实例配置参数优先级高于外部参数。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreatePod
Version	Query	String	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
product_id	string	是	实例所归属的业务 ID
pod_name	string	否	自定义实例名称，如不指定，则默认为实例 ID（批量创建实例时为实例名称前缀）
image_id	string	否	自定义镜像 ID，如不指定，则默认使用平台提供的官方标准镜像
configuration_code	string	否	运行资源的套餐规格 ID，可选项为： ultimate（旗舰型） enhanced（加强型） common（通用型） sample（入门型） basic（基础型） elementary（低配型）（批量创建实例时，如 `pod_spec_list` 中未指定套餐 ID，则该参数为必选）
data_size	string	否	创建实例的用户存储分区大小（即 data 分区容量大小），可选的容量如下（容量大小和单位不可自定义）： 4Gi 8Gi 16Gi 32Gi 64Gi 128Gi 256Gi 注：如不指定，则默认使用 8Gi 容量（建议调用方在调用时，结合实际业务情况，按需填写存储大小，默认 8Gi 容量对部分业务会偏小）
dc	string	否	机房 ID（如指定，则在此机房创建实例；批量创建实例时，如 `pod_spec_list` 中未指定机房 ID，则该参数为必选）
display_layout_id	string	是	屏幕布局，全局屏幕配置；可通过调用 ListDisplayLayoutMini 接口获取；可选的系统屏幕布局 ID 包括： single-display-landscape single-display-portrait single-display-portrait-720p 说明：如未指定屏幕布局 ID，运行资源套餐为 “入门型” 的云手机实例将会使用 720P 和 30fps 的默认配置）
overlay_settings	`list<Settings>`	否	实例初始化 Settings 属性列表；详细信息，参考 Settings 定义
overlay_property	`list<SystemProperties>`	否	实例初始化系统属性，非持久化，立即生效，重启实例后失效；详细信息，参考 System Properties 定义
overlay_persist_property	`list<SystemProperties>`	否	实例初始化系统属性，持久化，重启实例后生效；详细信息，参考 System Properties 定义说明：适用于只读系统属性，或 AOSP 原生非持久化的系统属性的修改，如 ro.product.model
start	bool	否	创建完成后是否立即开机，默认为 false（关机）
tag_id	string	否	自定义标签
up_bandwidth_limit	int32	否	实例上行带宽上限（单位：Mbps；如设置为0，则不限速）
down_bandwidth_limit	int32	否	实例下行带宽上限（单位：Mbps；如设置为0，则不限速）
pod_spec_list	[]PodSpec	否	批量创建实例时，指定实例配置定义，详细信息，参考 PodSpec 定义
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 结构说明。

Result 字段包含以下参数：

字段	类型	说明
pod_id	string	创建成功的实例 ID（创建单个实例时有效）
pod_id_list	[]string	创建成功的实例 ID 列表（批量创建实例时有效）

示例

请求示例

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

{
    "product_id":"1591495366954xxxxxx",
    "pod_name":"测试实例",
    "configuration_code":"basic",
    "image_id":"img-76xxxxxx",
    "data_size":"4Gi",
    "dc": "gdsz-ctcucm-01-xxxxxxxx",
    "start": false,
    "up_bandwidth_limit":0,
    "down_bandwidth_limit":0,
    "ip_white_list": "127.0.0.1,127.0.0.2"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreatePod",
        "Region": "cn-north-1",
        "RequestId": "20231026114318A3195D5A6B6EC8F51017",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "pod_id": "7294107154305xxxxxx",
        "pod_id_list": []
    }
}

错误码

错误码	说明	操作建议
8030007	业务存储不足	确保对应业务下有可订购存储
8030008	业务并发不足	确保对应业务下有可订购并发
8030010	所属业务欠费关停	确保业务下的资源订单按时充值付费
8060005	操作的实例数量超过批量操作上限	参考说明文档，检查可批量执行的实例数量上限，建议减少并发请求
8090001	找不到屏幕布局	联系火山引擎云手机技术支持