Search Topology¶

查询场站内拓扑结构的基本信息。

操作权限¶

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

需授权的策略	所需操作权限
设备管理	Read
资产树管理员	Read

约束条件¶

当前 OU 已绑定 OU 模板，且模板内已配置拓扑规则。

请求格式¶

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

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	组织 ID。获取 orgId 信息>>
siteAssetId	Query	可选	String	场站的资产 ID。若提供该信息，则查询条件将忽略 topologyRootId。
topologyRootId	Query	可选	String	以当前传入资产 ID 为顶层节点的拓扑结构列表。如果为空，必需提供 ``siteAssetId``参数，查询场站内所有拓扑结构列表。
topologyRuleId	Query	可选	String	拓扑规则的标识符。

响应参数¶

名称	数据类型	描述
data	TopologyInfo 结构体数组	拓扑树的信息列表。

TopologyInfo 结构体¶

名称	数据类型	描述
topologyId	String	拓扑树的标识符。
topologyRuleId	String	拓扑规则的标识符。

错误码¶

代码	错误信息	描述
99500	Internal server error	服务器内部错误，请联系 EnOS 技术支持团队。

示例¶

请求示例¶

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

method: POST

返回示例¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "05acbed9-5288-4183-88f4-da300dd54874",
    "data": [{
        "topologyId": "LyQOvJa3/HnfxM8Rc",
        "topologyRuleIdentifier":"Solar_SoilingGroup"
    }]
}