根据已购入的实例套餐规格，在指定机房内创建一个新的云手机实例，并将一批指定应用程序安装到新创建的实例中。

使用说明

• 调用本接口前，请确保已通过云手机控制台或 UploadApp 接口将应用安装文件上传至应用管理中心。
• 调用本接口发送请求后，会生成异步执行的应用安装任务。您可以参考云手机回调服务接入指南，通过配置“任务执行回调”，获取任务执行结果。
• 本接口限单次创建 1 个实例。如需一次性批量创建多个实例，您可以使用 CreatePod 接口，但请注意 CreatePod 仅负责实例创建，应用上传需通过 InstallApp 接口另行处理。

注意事项

• 若指定安装的应用列表，即 AppList 参数中传入的应用 ID 错误或异常，整个应用安装任务将不会被执行。
• 由于网络、存储、及其他非应用 ID 问题导致的某一应用安装失败，并不影响其它应用的安装进程，即接口不会返回失败。 您可以通过回调查看各应用安装情况。
• 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

Body

Settings

SystemProperty

AppInfo

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

请求示例

POST https://open.volcengineapi.com?Action=CreatePodOneStep&Version=2023-10-30
{
    "ProductId": "1591495366954xxxxxx",
    "PodName": "测试实例",
    "ImageId": "img-7616xxxx",
    "ConfigurationCode": "enhanced",
    "DataSize": "4Gi",
    "Dc": "gdsz-ctcucm-01-5fxxxxxx",
    "DisplayLayoutId": "single-display-landscape",
    "OverlaySettings": [
        {
            "SettingsName": "locale_language",
            "SettingsType": "global",
            "SettingsValue": "on",
            "SettingsValueType": "string"
        }
    ],
    "OverlayProperty": [
        {
            "SystemPropertyName": "ro.product.name",
            "SystemPropertyValue": "LYA_AL00",
            "SystemPropertyValueType": "string"
        }
    ],
    "OverlayPersistProperty": [
        {
            "SystemPropertyName": "ro.product.name",
            "SystemPropertyValue": "LYA_AL00",
            "SystemPropertyValueType": "string"
        }
    ],
    "TagId": "tag_01",
    "UpBandwidthLimit": 0,
    "DownBandwidthLimit": 0,
    "AppList": [
        {
            "AppId": "7278660795155xxxxxx",
            "VersionId": "7278660795155xxxxxx"
        }
    ],
    "PortMappingRuleIdList": [
        "flattened"
    ],
    "HostId": "7337159054625xxxxxx",
    "ResourceType": 200
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreatePodOneStep",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "PodId": "7294157141458xxxxxx",
        "TaskId": "7294157141458xxxxxx",
        "TaskAction": "CreatePod"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。