查询实例属性列表 GetPodProperty--云手机-火山引擎

文档中心

立即注册

导航

查询实例属性列表 GetPodProperty

最近更新时间：2025.11.03 17:18:49首次发布时间：2023.11.29 20:33:07

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

注意事项

请求参数中，5 种属性必须至少填写一个，不可全部置空。
本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetPodProperty`	接口名称。当前 API 的名称为 `GetPodProperty`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	实例所属的业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
PodId	String	是	`7235890322201xxxxxx`	实例 ID，可通过调用 `ListPod`接口获取。
SettingSecureNameList	String	否	`location_mode`	筛选条件，secure 类型 setting 名称列表，多个属性名称以英文逗号分隔；可查询的 setting 名称，参考云手机实例属性列表
SettingGlobalNameList	String	否	`settings.install_whitelist`	筛选条件，global 类型 setting 名称列表，多个属性名称以英文逗号分隔；可查询的 setting 名称，参考云手机实例属性列表
SettingSystemNameList	String	否	`launcher3_remove_drawer`	筛选条件，system 类型 setting 名称列表，多个属性名称以英文逗号分隔；可查询的 setting 名称，参考云手机实例属性列表
PropertyNameList	String	否	`ro.product.device`	筛选条件，非持久化属性列表，多个属性名称以英文逗号分隔；可查询的非持久化属性，参考云手机实例属性列表
PersistPropertyNameList	String	否	`ro.product.model`	筛选条件，持久化属性列表，多个属性名称以英文逗号分隔；可查询的持久化属性，参考云手机实例属性列表

返回参数

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

参数	类型	示例值	描述
PropertyList	JSON Map	`{"ro.product.device": "HWLYA"}`	查询到的非持久化属性列表。
PersistPropertyList	JSON Map	`{"ro.product.model", "LYA_AL00"}`	查询到的持久化属性列表。
SettingGlobalList	JSON Map	`{"settings.install_whitelist": "com.example1"}`	查询到的 global 类型 setting 值列表。
SettingSecureList	JSON Map	`{"location_mode": "0"}`	查询到的 secure 类型 setting 值列表。
SettingSystemList	JSON Map	`{"launcher3_remove_drawer": "1"}`	查询到的 system 类型 setting 值列表。

请求示例

GET https://open.volcengineapi.com?Action=GetPodProperty&Version=2023-10-30&ProductId=1591495366954xxxxxx&PodId=7235890322201xxxxxx&SettingGlobalNameList=settings.install_whitelist&PropertyNameList=ro.product.device

返回示例

{
    "ResponseMetadata": {
        "Action": "GetPodProperty",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "PropertyList": {
            "ro.product.device": "HWLYA"
        },
        "SettingGlobalList": {
            "settings.install_whitelist": "com.example1"
        }
    }
}

错误码

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