一键快速创建实例、启动实例,并完成应用部署(异步任务)。
实例创建结果通过任务执行回调返回,详细信息,参考 回调服务接入指南。
单次调用仅支持创建一个实例,并将一批指定应用安装到创建的实例中;
若指定安装的应用列表中有应用 ID 错误或异常,整个任务将不会被执行;应用安装任务执行过程中,若其中某个应用安装失败,不影响该任务下的其他应用执行安装;
确保指定的业务下有足够的运行资源,若运行资源不足,则会导致实例启动失败,对应的应用安装任务将不会被执行。
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
|---|---|---|---|---|---|
| Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | CreatePodOneStep |
| Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2022-08-01 |
字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| product_id | string | 是 | 实例所归属的业务 ID |
| pod_name | string | 否 | 自定义实例名称,如不指定,则默认为实例 ID |
image_id | string | 否 | 自定义镜像 ID,如不指定,则默认使用平台提供的官方标准镜像 |
configuration_code | string | 是 | 运行资源的套餐规格 ID,可选项为:
|
data_size | string | 否 | 创建实例的用户存储分区大小(即 data 分区容量大小),可选的容量如下(容量大小和单位不可自定义):
注:如不指定,则默认使用 8Gi 容量(建议调用方在调用时,结合实际业务情况,按需填写存储大小,默认 8Gi 容量对部分业务会偏小) |
| dc | string | 是 | 机房 ID |
display_layout_id | string | 是 | 屏幕布局,全局屏幕配置;可通过调用 ListDisplayLayoutMini 接口获取;可选的系统屏幕布局 ID 包括:
说明:如未指定屏幕布局 ID,运行资源套餐为 “入门型” 的云手机实例将会使用 720P 和 30fps 的默认配置) |
| overlay_settings | list<Settings> | 否 | 实例初始化 Settings 属性;详细信息,参考 Settings 定义 |
overlay_property |
| 否 | 实例初始化系统属性,非持久化,立即生效,重启实例后失效;详细信息,参考 System Properties 定义 |
overlay_persist_property |
| 否 | 实例初始化系统属性,持久化,重启实例后生效;详细信息,参考 System Properties 定义 |
| tag_id | string | 否 | 自定义标签 |
| app_list | list<AppInfo> | 是 | 创建实例后,需要安装的应用列表,参考以下 AppInfo 结构说明 |
| up_bandwidth_limit | int32 | 否 | 实例上行带宽上限(单位:Mbps;如设置为0,则不限速) |
| down_bandwidth_limit | int32 | 否 | 实例下行带宽上限(单位:Mbps;如设置为0,则不限速) |
ip_white_list | String | 否 | 配置白名单 IP,您可根据自身业务需求,自定义设置 IP。对白名单 IP 不限速,同时对 pod 访问的其他 IP 进行整体限制。目前仅支持配置 10 个白名单 IP。例如, 说明 如果设置 |
AppInfo 结构说明
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| app_id | string | 是 | 应用 ID |
| version_id | interface{} | 是 | 应用版本号ID |
通用返回参数,请参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
|---|---|---|
| pod_id | string | 创建成功的实例 ID |
| task_id | string | 任务 ID,用于通过 任务信息查询 接口查看任务执行状态及结果 |
| task_action | string | 任务类型,默认为对应接口 Action 名称,此处为 CreatePod |
POST https://open.volcengineapi.com?Action=CreatePodOneStep &Version=2022-08-01 &<通过header传入的公共请求参数> { "product_id":"1591495366954455040", "pod_name":"测试实例01", "image_id":"img-76161282", "data_size":"4Gi", "dc":"gdsz-ctcucm-01-5f53d8b4", "configuration_code":"basic", "app_list":[ { "app_id":"7280422115605076795", "version_id":7280422115605093179 } ], "overlay_settings": [ { "settings_type":"global", "settings_name":"locale_language", "settings_value":"en-US", "settings_value_type":"string" }, { "settings_type":"secure", "settings_name":"statusbar_switch", "settings_value":"off", "settings_value_type":"string" } ] }
{ "ResponseMetadata": { "Action": "CreatePodOneStep", "Region": "cn-north-1", "RequestId": "202310261458***B0460DEA2E06713F3", "Service": "ACEP", "Version": "2022-08-01" }, "Result": { "pod_id": "7294157141458xxxxxx", "task_id": "7294157141458xxxxxx", "task_action": "CreatePod" } }
| 错误码 | 说明 | 操作建议 |
|---|---|---|
| 8030007 | 业务存储不足 | 确保对应业务下有可订购存储 |
| 8030008 | 业务并发不足 | 确保对应业务下有可订购并发 |
| 8030010 | 所属业务欠费关停 | 确保业务下的资源订单按时充值付费 |
| 8040000 | 应用相关错误 | 联系火山引擎云手机技术支持 |
| 8050001 | 任务创建错误 | 参考说明文档,检查任务创建的条件 |
| 8060005 | 操作的实例数量超过批量操作上限 | 参考说明文档,检查可批量执行的实例数量上限,建议减少并发请求 |
| 8090001 | 找不到屏幕布局 | 联系火山引擎云手机技术支持 |