【旧版】修改实例属性 UpdatePodProperty--云手机-火山引擎

文档中心

立即注册

导航

【旧版】修改实例属性 UpdatePodProperty

最近更新时间：2025.11.03 17:18:49首次发布时间：2024.03.04 19:40:02

修改指定实例的属性信息，包括系统属性（SystemProperties）和设置（Settings）。

使用说明

在关机和开机状态下调用该接口时，接口行为如下：

关机状态下调用：Settings、持久化和非持久化 property 在实例开机后立即生效。
开机状态下调用：Settings、持久化和非持久化 property 立即生效。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdatePodProperty`	接口名称。当前 API 的名称为 `UpdatePodProperty`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1591495366954xxxxxx`	实例所归属的业务 ID，可在云手机控制台-业务管理-业务详情中获取。
PodId	String	否	`7294157141458xxxxxx`	实例 ID，可通过调用 ListPod 接口获取。若仅需更新单个实例的属性，请使用该参数。批量操作实例更新属性，请使用 `PodIdList`参数。
PodIdList	Array of String	否	`[7294157141458xxxxxx,72941579891458xxxxxx]`	实例 ID 列表，若需一次性更新多个实例的属性，请使用该参数。支持批量操作的实例数上限为 200。更新单个实例属性，请使用`PodId`参数。
PodSettings	Array of Settings	否	`-`	实例 Settings 属性列表。参看 Settings数据结构说明。
PodProperties	Array of SystemProperty	否	`-`	实例系统属性列表，非持久化，立即生效，重启实例后失效。参看 SystemProperty数据结构说明。
PodPersistProperties	Array of SystemProperty	否	`-`	实例系统属性列表，持久化，立即生效，重启实例后持久化保存。参看 SystemProperty数据结构说明。
PropertyRuleName	String	否	`HW`	预设的机型参数名称。创建实例时，若通过 `UsePropertyRule` 参数选择使用预设机型参数规则，可通过该参数修改使用的规则。可选的机型参数规则列表可通过 `ListPropertyRule`接口获取。

Settings

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

SystemProperty

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

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

参数	类型	是否必选	示例值	描述
SystemPropertyName	String	是	`ro.product.name`	属性名称，可修改的系统属性及属性值，参考 System Properties 属性列表。
SystemPropertyValue	String	是	`samsung`	属性值。取值如下： bool: "true"、"false" int\long: "21312" float: "2131.09" string: "safehg" 说明当 `SystemPropertyValueType` 参数取值不同，该 `SystemPropertyValue` 参数对应的取值不同。
SystemPropertyValueType	String	是	`string`	属性值数据类型。取值如下： `int` `long` `string` `float` `bool`

SystemPropertyValue

String

是

samsung

属性值。取值如下：

bool: "true"、"false"
int\long: "21312"
float: "2131.09"
string: "safehg"

说明

当 SystemPropertyValueType 参数取值不同，该 SystemPropertyValue 参数对应的取值不同。

SystemPropertyValueType

String

是

string

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

int
long
string
float
bool

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://open.volcengineapi.com?Action=UpdatePodProperty&Version=2023-10-30
{
    "ProductId": "1591495366954xxxxxx",
    "PodId": "7294157141458xxxxxx",
    "PodSettings": [
        {
            "SettingsType": "global",
            "SettingsName": "locale_language",
            "SettingsValue": "en-US",
            "SettingsValueType": "string"
        },
        {
            "SettingsType": "global",
            "SettingsName": "hide_sim_switch",
            "SettingsValue": "1",
            "SettingsValueType": "int"
        }
    ],
    "PodProperties": [
        {
            "SystemPropertyName": "ro.product.name",
            "SystemPropertyValue": "LYA_AL00",
            "SystemPropertyValueType": "string"
        }
    ],
    "PodPersistProperties": [
        {
            "SystemPropertyName": "ro.product.brand",
            "SystemPropertyValue": "HW",
            "SystemPropertyValueType": "string"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023060411042***00232280022D31",
        "Action": "UpdatePodProperty",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": "success"
}

错误码

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