设置实例属性 UpdateInstanceProperty--云手机-火山引擎

文档中心

立即注册

导航

设置实例属性 UpdateInstanceProperty

最近更新时间：2024.05.09 17:19:40首次发布时间：2022.03.25 20:09:15

设置云手机实例属性信息（异步），使用方法如下：

调用本接口设置实例属性，获取任务 ID（job_id）;
调用 GetJobDetails 接口，传入步骤 1 中获取的任务 ID，查看任务执行是否成功；
调用 GetInstanceProperty 接口，查询实例属性信息，获取任务 ID（job_id）;
调用 GetJobDetails 接口，传入步骤 3 中获取的任务 ID，查看实例属性是否已设置成功。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
object_type	String	是	对象的类别，可选枚举值包括： instance（对指定实例为对象进行操作） host（对云机下的所有实例进行操作）
object_id_list	String[]	是	对象 ID 列表，需要与指定的对象类别匹配，不可传入空列表
instance_property	Map	是	实例属性信息，参考以下 InstanceProperty 结构说明

InstanceProperty 结构说明

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

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
job_id	String	任务 ID，用于通过调用 GetJobDetails 接口，获取任务执行结果
passed_id_list	String[]	成功的实例 ID 列表
failed_id_list	Array of objects	失败的实例 ID 及对应错误信息列表，参考 `List<CaseWithMsg>` 结构说明

List<CaseWithMsg> 结构说明

字段	类型	说明
id	String	操作对象的 ID，如实例 ID、云机 ID
msg	String	操作失败的错误信息

示例

请求示例

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

{
    "product_id": "14677396781xxxxxxxx",
    "object_type": "instance",
    "object_id_list": ["i-1726334685xxxxxx","i-1726334685xxxxxx"],
    "instance_property": {
        "property_name": "brand",
        "property_value": "self_defined"
    }
}

返回示例

{
    "ResponseMetadata": {
        "Action": "UpdateInstanceProperty",
        "Region": "cn-north-1",
        "RequestId": "202203091616060101980160152617650B",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "job_id": "req-7072700279036072223",
        "passed_id_list": [
            "i-1726334685xxxxxx",
            "i-1726334685xxxxxx"
        ],
        "failed_id_list": []
    }
}