Search Site¶
查询场站基本信息。
请求参数(Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
expression | 可选 | String | 查询表达式,目前支持的字段有
|
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) |
|
tags | Map(Key 为 String,Value 为 String) |
|
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
}
}