Search Device¶

查询全部或指定场站下设备的基本信息。

操作权限¶

使用此 API 前，确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息，参见管理服务账号。

需授权策略	所需操作权限
设备管理	Read

约束条件¶

当前 OU 已绑定 OU 模板。

请求格式¶

POST https://{apigw-address}/amc/v1.0/device?action=search

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	可选	String	设备所属的组织 ID。获取 orgId 信息>>
siteAssetId	Query	可选。若提供该信息，则必须提供 `orgId`。	String	设备所属场站的资产 ID。不填则默认返回所有场站下的设备信息。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
deviceTypes	可选	List	设备类型标识符的列表。
queryTopologyParams	可选	QueryTopologyParam 结构体	设备的拓扑相关信息。若提供该信息，则查询条件将忽略 `siteAssetId`。
pagination	可选	Pagination 请求结构体	用于描述分页请求。每页最大记录数为 200 条。如未指定，默认分页大小是 10。仅支持指定 `pageNo` 和 `pageSize` 参数。查询结果将新创建的设备靠前排列。

QueryTopologyParam 结构体¶

名称	必需/可选	数据类型	描述
topologyId	必需	String	设备所在的拓扑结构 ID。
parentAssetId	可选	String	设备在拓扑结构上的父节点所挂载的资产 ID。

响应参数¶

名称	数据类型	描述
data	Device 结构体数组	指定拓扑结构的指定场站下的设备信息。

Device 结构体¶

名称	数据类型	描述
assetId	String	设备的资产 ID。
name	StringI18n	设备名称。
modelId	String	设备所属的模型 ID。
timezone	String	设备所在时区。
description	String	设备描述。
attributes	Map（`Key` 为 String，`Value` 为 Object）	设备属性。 `Key` 为属性 ID，`Value` 为属性值。
tags	Map（`Key` 为 String，`Value` 为 String）	设备的标签。 `Key` 为标签键，`Value` 为标签值。
typeInfo	Metadata 结构体	设备类型信息。

Metadata 结构体¶

名称	数据类型	描述
identifier	String	设备类型标识符。
name	StringI18n	设备类型名称。
type	String	设备的业务对象分类：DEVICE。

错误码¶

代码	错误信息	描述
99500	Internal server error	服务器内部错误，请联系 EnOS 技术支持团队。
99400	Invalid pagination parameters	pagination 参数无效，请检查请求参数。
99400	Operators {xxx} are not supported. Please use these operators: {yyy}	不受支持的表达式操作符。xxx 是不受支持的操作符，yyy 是受支持的操作符。
99400	PageSize value cannot exceed 200	`pagination` 中 `pageSize` 参数的值不能大于 200。

示例¶

请求示例¶

URL: https://{apigw-address}/amc/v1.0/device?action=search?orgId=yourOrgId

method: POST

requestBody:
{
    "pagination":{
        "pageNo":1,
        "pageSize":10
    },
    "queryTopologyParams":{
        "parentAssetId":"x4zeFkkf",
        "topologyId":"your topology Id"
    },
    "deviceTypes":[
        "WeatherStation"
    ]
}

返回示例¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "ea17e9e4-81b7-463c-944f-565dcb0dd4c7",
    "data": [{
        "assetId": "GUPUw1bM",
        "name": {
            "defaultValue": "1",
            "i18nValue": {}
        },
        "modelId": "EnOS_Solar_WST_Generic",
        "timezone": "+08:00",
        "description": "",
        "attributes": {
            "calcMode": "A"
        },
        "tags": {
            "amc_assetGroup_HnfxM8Rc": "HnfxM8Rc",
            "AMC_MOUNTED_hxaSSfM5": "hxaSSfM5",
            "amc_modelNo": "Others7",
            "amc_source": "amc",
            "amc_manufacturer": "ID099",
            "amc_deviceType": "WeatherStation",
            "amc_classType": "Device",
            "AMC_MOUNTED_LyQOvJa3": "LyQOvJa3"
        },
        "typeInfo": {
            "identifier": "WeatherStation",
            "name": {
                "defaultValue": "Weather Station",
                "i18nValue": {
                    "en_US": "Weather Station",
                    "zh_CN": "气象站"
                }
            },
            "type": "Device"
        }
    }],
    "pagination": {
        "sortedBy": null,
        "pageNo": 1,
        "pageSize": 10,
        "totalSize": 1
    }
}