单实例批量获取属性 GetInstanceProperties--云手机-火山引擎

文档中心

立即注册

导航

单实例批量获取属性 GetInstanceProperties

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

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

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

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

字段

类型

必填

说明

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

property_names

Array of string

是

批量查询的实例属性名称列表，可查询的属性列表参考附件，使用限制如下：

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

返回结果

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

Result 字段包含以下参数：

字段	类型	说明
property_name	String	属性名称
property_value	String	属性值

示例

请求示例

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

{
    "instance_id": "i-1756805751xxxxxx",
    "property_names": ["wifi.interface","brand"]
}

返回示例

{
    "ResponseMetadata": {
        "Action": "GetInstanceProperties",
        "Region": "cn-north-1",
        "RequestId": "201806041104200100100232280022D30",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "properties": [
            {
                "property_name": "wifi.interface",
                "property_value": "wlan0"
            },
            {
                "property_name": "brand",
                "property_value": "seld-defined"
            }
        ]
    }
}