查询机型库 GetPhoneTemplate--云手机-火山引擎

文档中心

立即注册

导航

查询机型库 GetPhoneTemplate

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

查询指定机型库的详细信息。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

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

参数	类型	示例值	描述
PhoneTemplate	Object of PhoneTemplate	`-`	机型库详细信息。参见 PhoneTemplate 定义。
Tags	Array of PhoneTemplateTag	`-`	机型库标签详细信息。参见 PhoneTemplateTag 定义。

PhoneTemplate

参数	类型	示例值	描述
Status	Integer	`1`	机型库状态。 1：已发布 2：测试中 3：已废弃
AospVersion	String	`10`	AOSP 版本号。
OverlayProperty	Array of SystemProperty	`-`	实例 System Properties 系统属性。参看 SystemProperty 定义。
OverlaySettings	Array of Settings	`-`	实例 Settings 属性。参看 Settings 定义。
PhoneTemplateId	String	`7658996557xxxxxx`	机型库 ID。
PhoneTemplateName	String	`Oppo1`	机型库名称。
OverlayPersistProperty	Array of SystemProperty	`-`	实例初始化系统属性。参看 SystemProperty 定义。

PhoneTemplateTag

参数	类型	示例值	描述
TagId	String	`7658996557xxxxxx`	机型库标签 ID。
TagDesc	String	`国内通用机型`	机型库标签描述。
TagName	String	`国内通用`	机型库标签名称。
AccountId	String	`21******`	机型库标签所属的火山账号 ID。

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"

请求示例

POST https://open.volcengineapi.com?Action=GetPhoneTemplate&Version=2025-05-01
{
    "PhoneTemplateId": "7658996557xxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "GetPhoneTemplate",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "PhoneTemplate": {
            "Status": 1,
            "AospVersion": "10",
            "OverlayProperty": [
                {
                    "SystemPropertyName": "ro.product.name",
                    "SystemPropertyValue": "samsung",
                    "SystemPropertyValueType": "string"
                }
            ],
            "OverlaySettings": [
                {
                    "SettingsName": "locale_language",
                    "SettingsType": "global",
                    "SettingsValue": "zh-CN",
                    "SettingsValueType": "string"
                }
            ],
            "PhoneTemplateId": "7658996557xxxxxx",
            "PhoneTemplateName": "Oppo1",
            "OverlayPersistProperty": [
                {
                    "SystemPropertyName": "ro.product.name",
                    "SystemPropertyValue": "samsung",
                    "SystemPropertyValueType": "string"
                }
            ]
        },
        "Tags": [
            {
                "TagId": "7658996557xxxxxx",
                "TagDesc": "国内通用机型",
                "TagName": "国内通用",
                "AccountId": "21******"
            }
        ]
    }
}

错误码

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