添加机型库 AddPhoneTemplate--云手机-火山引擎

文档中心

立即注册

导航

添加机型库 AddPhoneTemplate

最近更新时间：2025.10.28 14:59:03首次发布时间：2025.10.28 14:59:03

添加机型库并预设机型参数配置，创建云手机时指定机型库可匹配其中的预设参数。

注意事项

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=AddPhoneTemplate&Version=2025-05-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AddPhoneTemplate`	接口名称。当前 API 的名称为 `AddPhoneTemplate`。
Version	String	是	`2025-05-01`	接口版本。当前 API 的版本为 `2025-05-01`。

Body

参数	类型	是否必选	示例值	描述
PhoneTemplateName	String	是	`Oppo1`	机型库名称，账户下规则名称唯一，长度不能超过 200 个字符。
OverlayProperty	Array of SystemProperty	否	`-`	实例 Settings 系统属性，非持久化，立即生效，重启实例后失效；详细信息，参考 SystemProperty 定义。
OverlayPersistProperty	Array of SystemProperty	否	`-`	实例初始化系统属性，持久化，重启实例后生效；详细信息，参考 SystemProperty 定义：适用于只读系统属性，或 AOSP 原生非持久化的系统属性的修改，如 ro.product.model。
OverlaySettings	Array of Settings	否	`-`	实例 Settings 属性列表；详细信息，参考 Settings 定义。
AospVersion	String	是	`10`	AOSP 版本号。
Status	Integer	是	`1`	机型库状态。 1：已发布 2：测试中 3：已废弃

SystemProperty

参数类型是否必选示例值描述

SystemPropertyName String 是 ro.product.name 属性名称，已可修改的系统属性及属性值，参考 System Properties 属性列表。

SystemPropertyValue String 是 samsung 属性值。

参数	类型	是否必选	示例值	描述
SystemPropertyName	String	是	`ro.product.name`	属性名称，已可修改的系统属性及属性值，参考 System Properties 属性列表。
SystemPropertyValue	String	是	`samsung`	属性值。
SystemPropertyValueType	String	是	`string`	属性值数据类型。取值如下： `int` `long` `string` `float` `bool`

SystemPropertyValueType

String

是

string

属性值数据类型。取值如下：

int
long
string
float
bool

Settings

参数	类型	是否必选	示例值	描述
SettingsName	String	是	`locale_language`	属性名称，已可修改的 Settings 属性及属性值，参考 Settings 属性列表。
SettingsType	String	是	`global`	设置类型，取值如下： `global` `secure` `system`
SettingsValue	String	是	`zh-CN`	属性值数据类型，取值如下： `int` `long` `string` `float` `bool`
SettingsValueType	String	是	`string`	属性值。各类型属性取值示例如下： bool: "true"、"false" int\long: "21312" float: "2131.09" string: "safehg"

返回参数

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

参数	类型	示例值	描述
PhoneTemplateId	String	`7658996557xxxxxx`	机型库 ID。

请求示例

POST https://open.volcengineapi.com?Action=AddPhoneTemplate&Version=2025-05-01
{
    "PhoneTemplateName": "Oppo1",
    "OverlayProperty": [
        {
            "SystemPropertyName": "ro.product.name",
            "SystemPropertyValue": "samsung",
            "SystemPropertyValueType": "string"
        }
    ],
    "OverlayPersistProperty": [
        {
            "SystemPropertyName": "ro.product.name",
            "SystemPropertyValue": "samsung",
            "SystemPropertyValueType": "string"
        }
    ],
    "OverlaySettings": [
        {
            "SettingsName": "locale_language",
            "SettingsType": "global",
            "SettingsValue": "zh-CN",
            "SettingsValueType": "string"
        }
    ],
    "AospVersion": "10",
    "Status": 1
}

返回示例

{
    "ResponseMetadata": {
        "Action": "AddPhoneTemplate",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "PhoneTemplateId": "7658996557xxxxxx"
    }
}

错误码

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