单实例批量设置属性 SetInstanceProperties--云手机-火山引擎

文档中心

立即注册

导航

单实例批量设置属性 SetInstanceProperties

最近更新时间：2024.05.09 17:19:41首次发布时间：2023.02.15 11:13:23

设置指定云手机实例的多个属性信息（同步）。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	SetInstanceProperties
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25

Body 参数

字段	类型	必填	说明
instance_id	String	是	实例 ID，可通过调用 ListInstance 接口获取
properties	Array of objects	是	批量设置的实例属性列表，参考以下 InstanceProperties 结构说明，使用限制如下：属性名和属性值数组长度上限200 属性名称长度上限64 属性值长度上限91 不支持输入特殊字符，包括但不限于 `+- ;&\|(){}[]`

字段

类型

必填

说明

instance_id String 是实例 ID，可通过调用 ListInstance 接口获取

properties

Array of objects

是

批量设置的实例属性列表，参考以下 InstanceProperties 结构说明，使用限制如下：

属性名和属性值数组长度上限200
属性名称长度上限64
属性值长度上限91
不支持输入特殊字符，包括但不限于 +- ;&|(){}[]

InstanceProperties 结构说明

字段	类型	必填	说明
property_name	String	是	属性名称，例如：ro.product.brand 注：可设置的属性列表，参考附件
property_value	String	是	属性值，例如：self_defined

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

示例

请求示例

POST https://open.volcengineapi.com?Action=SetInstanceProperties
&Version=2020-10-25
&<通过header传入的公共请求参数>

{
    "instance_id": "i-1756805751xxxxxx",
    "properties": [
        {
            "property_name": "brand",
            "property_value": "self_defined"
        },
        {
            "property_name": "test.key.0",
            "property_value": "test-value-0"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "SetInstanceProperties",
        "Region": "cn-north-1",
        "RequestId": "201806041104200100100232280022D30",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {}
}