Search Site¶

查询场站基本信息。

操作权限¶

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

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

约束条件¶

当前 OU 已绑定 OU 模板。

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	场站所属的组织 ID。获取 orgId 信息>>

请求参数（Body）¶

名称

必需/可选

数据类型

描述

expression

可选

String

查询表达式，目前支持的字段有 attributes、name、assetId。

attributes：支持算术运算符 =、exists、not exists 和 in。使用该参数查询，需要通过 attributes.{attributeId} 的形式来指定具体参与查询表达式的属性。例如 attributes.temperature = 35.5。

name: 支持指定语言模糊查询：

name like 'xxx'：模糊查询默认、中文和英文名称。

name.default like 'xxx'：模糊查询默认名称。

name.zh_CN like 'xxx'：模糊查询中文名称，不存在中文名称时模糊查询默认名称。

name.en_US like 'xxx'：模糊查询英文名称，不存在英文名称时模糊查询默认名称。

assetId: 支持算术运算符 = 和 in。

如何使用查询表达式>>

如何获取 attributeId>>

siteTypeId

可选

String

场站类型标识符。若为空，结果将返回所有类型的场站。

pagination

可选

pagination 请求参数

分页请求。每页最大记录数为 200 条。如未指定，默认分页大小是 10。仅支持指定 pageNo 和 pageSize 参数。查询结果将新创建的场站靠前排列。

响应参数¶

名称	数据类型	描述
data	Site 结构体数组	场站信息。

Site 结构体¶

名称	数据类型	描述
assetId	String	场站的 Asset 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	场站的业务对象分类：SITE。

错误码¶

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

示例¶

请求示例¶

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

method: POST

requestBody:
{
    "pagination":{
        "pageNo":1,
        "pageSize":10
    },
    "expression":"attributes.altitude = 123.000000"
}

返回示例¶

{
    "code":0,
    "msg":null,
    "requestId":"f3bf3b13-058a-481d-88c0-06087fd36554",
    "data":[
        {
            "assetId":"HnfxM8Rc",
            "name":{
                "defaultValue":"123",
                "i18nValue":{

                }
            },
            "modelId":"EnOS_Solar_Site",
            "timezone":"+08:00",
            "description":null,
            "attributes":{
                "altitude":123,
                "latitude":123,
                "combinerBoxAmount":1,
                "capacity":123,
                "omtAmount":1,
                "bxtfAmount":1,
                "emtAmount":1,
                "wstAmount":1,
                "acCbxAmount":2,
                "equipmentAmount":1,
                "gmtAmount":1,
                "strInvAmount":0,
                "longitude":123
            },
            "tags":{
                "amc_source":"amc",
                "amc_deviceType":"SolarSite",
                "amc_classType":"Site"
            },
            "typeInfo":{
                "identifier":"SolarSite",
                "name":{
                    "defaultValue":"Solar Site",
                    "i18nValue":{

                    }
                },
                "type":"Site"
            }
        }
    ],
    "pagination":{
        "sortedBy":null,
        "pageNo":1,
        "pageSize":10,
        "totalSize":1
    }
}